serve open-api.yaml from API #8404
Draft
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
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.
Closes #8401
Change Description
Background
it will introduce a new route for users to be able to download the open-api-spec in yaml format from raw path of git repo.
Bug Fix
Not a bug.
New Feature
users with pass the open-api-yaml version or main and the file will be returned from the Github raw path. (more details will be added later)
Testing Details
TODO
Breaking Change?
it can be a breaking change, since there is already a route called "/openapi.json", we cab move it to "resources/openapi.json" as well, then it can be a breaking change. I need to communicate with the team to either prevent it or introduce this breaking change. (and potentially propose a solution)
Additional info
TODO
Contact Details
my email: [email protected]