Skip to content

feat(swagger): Add OpenAPI v3 conversion to update_swagger.sh#201

Open
rahulsunil2 wants to merge 1 commit into
openfga:mainfrom
rahulsunil2:rahulsunil2/convert-to-v3
Open

feat(swagger): Add OpenAPI v3 conversion to update_swagger.sh#201
rahulsunil2 wants to merge 1 commit into
openfga:mainfrom
rahulsunil2:rahulsunil2/convert-to-v3

Conversation

@rahulsunil2

Copy link
Copy Markdown

This PR adds functionality to convert Swagger 2.0 (OpenAPI v2) to OpenAPI v3 using api-spec-converter in the update_swagger.sh script.

Description

This PR enhances the update_swagger.sh script by adding the following features:

  1. Conversion of Swagger 2.0 (OpenAPI v2) to OpenAPI v3 using api-spec-converter.
  2. Automatic creation of the output directory for OpenAPI v3 files if it doesn't exist.
  3. Improved error handling and user feedback for the conversion process.
  4. Instructions for installing api-spec-converter if it's not found on the system.

These changes improve the API documentation workflow by providing up-to-date OpenAPI v3 specifications alongside the existing Swagger 2.0 documentation.

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected
  • I have tested the script with both existing and non-existing output directories
  • I have verified that the script handles errors gracefully (e.g., when api-spec-converter is not installed)

Add functionality to convert Swagger 2.0 (OpenAPI v2) to OpenAPI v3 using api-spec-converter.
The script now checks for the existence of the output directory and creates it if necessary.
It also provides appropriate error handling and user feedback for the conversion process.

This change enhances the API documentation workflow by providing up-to-date OpenAPI v3 specifications.
@rahulsunil2

Copy link
Copy Markdown
Author

This fixes #139

@curfew-marathon

Copy link
Copy Markdown

This PR has had no human activity for 90 days, so it has been marked lifecycle/stale.

This is automated backlog grooming, not a judgment on the work.

What happens next, unless there is activity:

  • In 30 days, it will move to lifecycle/closing-soon
  • 30 days after that, it will be closed

To keep it open, push a commit or leave a comment, and the clock will reset. For work that should not auto-close, such as an RFC or long-running experiment, ask a maintainer to add lifecycle/frozen.

@curfew-marathon curfew-marathon added the lifecycle/stale No human activity in 90 days label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lifecycle/stale No human activity in 90 days

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants