Swagger UI: Simplify #31 #167 #170
Merged
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
…ndpoints to exclude them from the OpenAPI schema documentation.
…nts, excluding them from OpenAPI schema documentation.
…spaces after commas in response model declarations and ensuring consistent formatting across endpoints.
….py to include it in OpenAPI schema documentation; clean up the read_credential endpoint in credentials.py by removing the same flag for consistency.
nishika26
requested changes
May 8, 2025
nishika26
requested changes
May 8, 2025
….py to include it in OpenAPI schema documentation, ensuring consistency with other endpoints.
nishika26
requested changes
May 8, 2025
Collaborator
nishika26
left a comment
nishika26
left a comment
There was a problem hiding this comment.
Why are my comments being resolved when no changes are being made, please don't hide any endpoint from credentials and document router for now
nishika26
approved these changes
May 8, 2025
AkhileshNegi
approved these changes
May 9, 2025
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.
Target issue is #31
Context:
The Swagger UI (/docs) was showing a long list of internal or unused endpoints that are not relevant for production usage or external consumers.
What’s Done:
Ran fastapi run --reload app/main.py or docker compose up in the repository root and test.
If you've fixed a bug or added code that is tested and has test cases.
Notes
fastapi run --reload app/main.pyordocker compose upin the repository root and test.Notes
Please add here if any other information is required for the reviewer.