Docs: Missing API Endpoint Docstrings and OpenAPI Integration#2
Open
Docs: Missing API Endpoint Docstrings and OpenAPI Integration#2
Conversation
The FastAPI server exposes several endpoints (`/config`, `/ws/progress`) but lacks docstrings for these functions and the `ConnectionManager` class. FastAPI leverages docstrings and type hints to automatically generate OpenAPI (Swagger UI) documentation. Without these, the auto-generated documentation will be sparse, and developers consuming the API will have to infer functionality from the code, leading to potential misunderstandings and increased integration effort. Affected files: server.py Signed-off-by: toanmap <174589430+maptoan@users.noreply.github.com>
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.
Problem
The FastAPI server exposes several endpoints (
/config,/ws/progress) but lacks docstrings for these functions and theConnectionManagerclass. FastAPI leverages docstrings and type hints to automatically generate OpenAPI (Swagger UI) documentation. Without these, the auto-generated documentation will be sparse, and developers consuming the API will have to infer functionality from the code, leading to potential misunderstandings and increased integration effort.Severity:
highFile:
src/api/server.pySolution
Add comprehensive docstrings to all public API endpoints and the
ConnectionManagerclass and its methods. Use type hints consistently to enhance the auto-generated OpenAPI documentation.Changes
src/api/server.py(modified)Testing