Skip to content

feat: add Pydantic response models and OpenAPI docs to analytics service#2

Merged
Sundriveauto merged 2 commits into
mainfrom
feat/fastapi-pydantic-schemas
Apr 27, 2026
Merged

feat: add Pydantic response models and OpenAPI docs to analytics service#2
Sundriveauto merged 2 commits into
mainfrom
feat/fastapi-pydantic-schemas

Conversation

@Sundriveauto
Copy link
Copy Markdown
Owner

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 examples
  • main.py — app-level description documenting auth requirements; explicit /docs and /redoc URLs
  • routes/analytics.pyresponse_model, summary, description + HTTPBearer security on all three endpoints
  • routes/batch.pyBatchVerifyRequest (max 100 wallets), BatchVerifyResponse, 400 error documented, auth note in description

Acceptance Criteria

  • /docs (Swagger UI) and /redoc available
  • All endpoints have Pydantic response models with field descriptions
  • Batch verify documents input format, size limits (max 100), and error responses
  • Authentication requirements documented per endpoint (Bearer JWT on analytics, public on batch/health)

Tested

Verified via app.openapi() — all 5 paths present, analytics endpoints show security=True, batch shows responses=['200','400','422'].

- 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
@Sundriveauto Sundriveauto merged commit 79eca77 into main Apr 27, 2026
0 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant