Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate Beckn Core Protocol Specification from OpenAPI 3.0 to 3.1: Release core spec version 1.1.1 #433

Closed
rajaneeshk90 opened this issue Jul 1, 2024 · 1 comment
Assignees
Labels
protocol-specifications specification related issues

Comments

@rajaneeshk90
Copy link
Collaborator

rajaneeshk90 commented Jul 1, 2024

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

@rajaneeshk90 rajaneeshk90 self-assigned this Jul 5, 2024
@rajaneeshk90 rajaneeshk90 changed the title Draft: Migrate Beckn Core Protocol Specification from OpenAPI 3.0 to 3.1 Migrate Beckn Core Protocol Specification from OpenAPI 3.0 to 3.1 Jul 5, 2024
@rajaneeshk90 rajaneeshk90 added the protocol-specifications specification related issues label Jul 5, 2024
@rajaneeshk90 rajaneeshk90 changed the title Migrate Beckn Core Protocol Specification from OpenAPI 3.0 to 3.1 Migrate Beckn Core Protocol Specification from OpenAPI 3.0 to 3.1: Release core spec version 1.1.1 Jul 11, 2024
@rajaneeshk90
Copy link
Collaborator Author

PR to the version branch: #434

PR to the main branch: #439

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol-specifications specification related issues
Projects
None yet
Development

No branches or pull requests

1 participant