Beckn Onix: Specification Doc for Registry Endpoints #295
Description
This is a continuation ticket for the work previously tracked in beckn/protocol-specifications#477.
Current Status
Review by Faiz in progress
Description
This task involves drafting a detailed, implementation-ready markdown specification for the Beckn Registry's /subscribe and /on_subscribe API endpoints as part of the Beckn Onix initiative. The document will serve as a reference guide for backend developers, enabling them to implement or integrate these endpoints with precision.
The documentation must follow the standard protocol specification format, including:
- Endpoint summary and purpose
- Required headers and authorization
- Request and response schema (with example payloads)
- Expected status codes
- Error handling
- Signature requirements (where applicable)
- Sequence and interaction flow
Example reference documentation for format and detail level:
Signing Beckn APIs in HTTP – Draft 01
Goals
- Document the
/subscribeand/on_subscribeAPI endpoint specifications - Include request/response examples and schema references
- Align documentation style with Beckn protocol standards
- Share draft with core reviewers and finalize after feedback
Expected Outcome
A complete and reviewed markdown document specifying the subscribe flow for registry endpoints, published as part of the Beckn Onix protocol documentation suite.
Acceptance Criteria
- Markdown doc follows the format and depth of existing protocol specifications
- Includes all necessary implementation details (headers, structure, security, etc.)
- Reviewed and approved by Faiz and other stakeholders
- Linked and referenced from core Onix documentation
Mockups / Wireframes
NA
Product Name
Beckn
Domain
Registry / Onix
Tech Skills Needed
Protocol Documentation, Markdown Authoring, API Specification Design, REST Standards
Complexity
Medium
Category
Documentation
Sub Category
API Specification for Registry