-
Notifications
You must be signed in to change notification settings - Fork 251
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
[Enhancement] Add versioning support to OpenAPI docs plugin #125
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Size Change: +378 kB (+14%) Total Size: 3.17 MB
ℹ️ View Unchanged
|
Visit the preview URL for this PR (updated for commit 4ca8e10): https://docusaurus-openapi-36b86--pr125-p3ineo8j.web.app (expires Sat, 09 Jul 2022 18:53:42 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
csestito
approved these changes
Jun 9, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a set of CLI commands for generating, cleaning, and managing versioned OpenAPI docs.
Motivation and Context
It isn't uncommon for OpenAPI specifications to be versioned along with the APIs they represent. The OpenAPI docs plugin should be capable of supporting this use case since it will be a common one.
How Has This Been Tested?
This PR introduces a versioned Petstore API in the demo, which has also been thoroughly tested locally.
Screenshots (if appropriate)
New CLI commands included below:
TODO