docs: add OpenAPI examples for analysis endpoints#920
Open
Neelr1912 wants to merge 2 commits into
Open
Conversation
Author
|
Implemented OpenAPI request and response examples for: /explanation/ Also added tests to verify examples are present in the generated OpenAPI schema. Fixes #205. |
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.
Description
This PR adds OpenAPI request and response examples for the analysis endpoints to improve the Swagger UI experience and make it easier for users to test APIs using the "Try it out" feature.
Changes Made
Added request examples for:
/explanation//debugging//suggestions//analyze/Added response examples using Pydantic schema metadata.
Added FastAPI
Body(..., examples=...)support for request payloads.Ensured examples are included in the generated OpenAPI schema.
Added tests to validate that request and response examples are present in
/openapi.json.Related Issue
Fixes #205
Type of Change
Testing
/docs).Notes
Any remaining failing tests are pre-existing repository issues and are unrelated to this PR.