Release Core Specification Version 1.1.1
@rajaneeshk90 is already working on this.
Since Jul 5, 2024.
Assessment
This issue has not been assessed yet.
Description
Background
The Beckn Core Protocol is currently specified using OpenAPI version 3.0. To leverage the latest features, improvements, and compliance enhancements in OpenAPI 3.1, there is a need to update the protocol specification.
Objectives
- Upgrade Specification: Update the Beckn Core Protocol YAML files to be compliant with OpenAPI 3.1.
- Validate Compatibility: Ensure that all existing API definitions are compatible with OpenAPI 3.1 syntax and semantics.
- Documentation and Examples: Update accompanying documentation and examples to reflect changes made during the migration.
- Tooling and Integration: Verify that all related tooling (e.g., code generators, validators, linters) support and work seamlessly with OpenAPI 3.1.
Tasks
- Review Changes in OpenAPI 3.1:
- Understand key differences between OpenAPI 3.0 and 3.1.
- Identify features in 3.1 that are relevant to the Beckn Core Protocol.
- Update YAML Files:
- Modify existing OpenAPI 3.0 YAML files to conform to OpenAPI 3.1 standards.
- Ensure all endpoints, schemas, and components are correctly defined.
- Testing and Validation:
- Use OpenAPI 3.1 validation tools to verify the updated specifications.
- Perform integration tests to ensure no regressions or issues arise from the migration.
- Update Documentation:
- Revise documentation to reflect changes in the specification.
- Provide updated examples and usage guidelines for developers.
- Coordinate with Stakeholders:
- Communicate with developers, integrators, and other stakeholders regarding the migration.
- Offer support and guidance for any issues arising from the update.
Expected Outcomes
- A fully migrated Beckn Core Protocol specification compliant with OpenAPI 3.1.
- Updated documentation and examples that align with the new specification.
- Enhanced compatibility with modern tooling and improved protocol features.
References
- OpenAPI 3.1 Specification
- Migration Guide from OpenAPI 3.0 to 3.1
- Dominant language
- No language data
- Stars
- 454
- Forks
- 127
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from beckn/protocol-specifications
-
Migrate default branch from `master` to `main`May be free again @ravi-prakash-v claimed this 371 days ago, and no pull request is open. Openworking group meeting
beckn/protocol-specifications#491 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
beckn/protocol-specifications#472 · 3 comments ·
-
Restructure spec repos to allow more interactive learning of the specMay be free again @rajaneeshk90 claimed this 715 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#455 · 1 assignee ·
-
Design specifications for Open Data platformMay be free again @rajaneeshk90 claimed this 715 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#454 · 1 assignee ·
-
Protocol-Specification Version 1.2 releaseMay be free again @rajaneeshk90 claimed this 715 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#451 · 2 comments · 1 assignee ·