Fix #23: Add OpenAPI spec generator and Redoc UI#44
Open
vratprem-art wants to merge 1 commit into
Open
Conversation
|
@vratprem-art is attempting to deploy a commit to the praise's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or 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
1 participant
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.
What does this PR do?
This PR generates an OpenAPI 3 spec from the miner's route definitions using an AST parser script. It includes auth scheme docs, a Redoc UI page, and a CI check.
Closes #23
Changes
scripts/generate_openapi.py: Added AST parser script to auto-generate specs from codedocs/openapi.yaml&docs/openapi.json: Generated API specsdocs/index.html: Added Redoc UI.github/workflows/openapi-check.yml: Added CI check to ensure specs stay in syncHow to test
docs/index.htmlin browser to view the Redoc UIpython scripts/generate_openapi.pylocally and verify files are updated