Open api Swagger UI #699
Merged
Open api Swagger UI #699
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
Closed
farisdurrani
approved these changes
Apr 14, 2023
|
Changes approved, will merge tonight |
|
ok. |
|
u can merge it when ready @farisdurrani |
openapi_continued
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.
Open API Standard
What user problem are we solving?
Standardize API documentation with Open API/Swagger paradigm
What solution does this PR provide?
Simple wrapper to take our existing flask backend and add support to add documentation via Open API
Github action to validate open api schemas
Testing Methodology
conda activate dlplayground && python -m backend.driverspin up
localhost:8000/apidocs. See if the documentations showsAny other considerations
test that things work and developers need to be on top of updating api documentation