feat: add OpenAPI examples for analysis endpoints#250
Open
Neelr1912 wants to merge 2 commits into
Open
Conversation
Author
|
@imDarshanGK Hi! I've added OpenAPI examples for all four analysis endpoints as requested in #205. All tests pass locally. Ready for your review |
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.
Closes #205
What changed
openapi_examplestoBody(...)on all four analysis endpoints:POST /explanation/— 3 examples (Python Fibonacci, JS async fetch, auto-detect Java)POST /debugging/— 3 examples (Python division-by-zero, JS undefined var, clean code)POST /suggestions/— 3 examples (Python missing types, JS var usage, high-score baseline)POST /analyze/— 3 examples (Python bubble sort, JS weak password, Python SQL injection)model_configwithjson_schema_extratoCodeRequestinschemas.pyfor the Schema tab in Swagger UI
How to verify
uvicorn app.main:app --reloadfrom thebackend/directoryChecklist
pytest -vpasses