feat(api): add APIFlask decorators to improve generated API spec doc#857
Draft
feat(api): add APIFlask decorators to improve generated API spec doc#857
Conversation
fix: schemas for file uploads and queue inputs
Update queue endpoints
fix sorting with numeric keys in examples
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
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.
This PR enhances the Server API documentation using inline docstrings and decorators in
v1.py, following APIFlask pattern. This improves the auto-generated OpenAPI spec with comprehensive documentation.Description
API endpoint documentation migrated from
server/API.mdtov1.py:@v1.inputand@v1.outputdecorators for request/response@v1.doc(responses={...})decorators for non-200 status codesschema.pySchema definition:
Resolved issues
CERTTF-780
Documentation
API.mdis no longer needed/v1/client-permissions, both POST and PUT endpoints were described in the Markdown file, but only PUT is defined in v1.pyWeb service API changes
API docstring and decorators are added or updated, no behavior changes.
Tests
Using the test introduced in #852 :