feat: add Pydantic response models and OpenAPI docs to analytics service#2
Merged
Merged
Conversation
- Add schemas.py with typed models for all endpoints - Document auth requirements (Bearer JWT) on analytics routes - Document batch/verify input limits (max 100), error responses - /docs (Swagger UI) and /redoc available out of the box
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.
Summary
Adds typed Pydantic schemas and full OpenAPI documentation to the FastAPI analytics service.
Changes
schemas.py— all request/response models with field descriptions and examplesmain.py— app-level description documenting auth requirements; explicit/docsand/redocURLsroutes/analytics.py—response_model,summary,description+HTTPBearersecurity on all three endpointsroutes/batch.py—BatchVerifyRequest(max 100 wallets),BatchVerifyResponse, 400 error documented, auth note in descriptionAcceptance Criteria
/docs(Swagger UI) and/redocavailableTested
Verified via
app.openapi()— all 5 paths present, analytics endpoints showsecurity=True, batch showsresponses=['200','400','422'].