Repository navigation
Add generated FastAPI API reference and drift check - #1311
Closed
ogunjobielijah09-cyber wants to merge 1 commit into
Closed
ogunjobielijah09-cyber wants to merge 1 commit into
ogunjobielijah09-cyber wants to merge 1 commit into
Conversation
|
@ogunjobielijah09-cyber Great news! 馃帀 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 馃殌 |
Contributor
|
Doing a repo-wide cleanup - closing all currently open pull requests to reset the board, not a judgement on this contribution. Nothing is lost: this branch and every commit on it still exist, and you're welcome to reopen this PR (or open a fresh one) at any time. If this was tracking an issue, that issue is being unassigned so it goes back into the open pool - feel free to comment on it to pick the work back up. Thanks for contributing to Soter. |
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
2 participants
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 #1213
Add generated FastAPI API reference artifacts and CI drift enforcement.
generate a checked-in OpenAPI snapshot from the live FastAPI app
generate a browsable markdown API reference from that schema
add a CI drift check to fail when the generated files no longer match the live app output
link the reference from the repo README for discoverability
This keeps the API contract documented in-source and ensures contributors update it whenever route or schema changes land.