Skip to content

feat: improve OpenAPI/Swagger documentation#40

Merged
felippemsc merged 2 commits intomainfrom
feat/swagger-improvements
Feb 6, 2026
Merged

feat: improve OpenAPI/Swagger documentation#40
felippemsc merged 2 commits intomainfrom
feat/swagger-improvements

Conversation

@felippemsc
Copy link
Contributor

@felippemsc felippemsc commented Feb 6, 2026

Summary

Improve OpenAPI/Swagger documentation for better developer experience.

  • Add missing tags (publishers, validate, security) for better endpoint organization
  • Add server definitions for production and development environments
  • Add authentication documentation to API description
  • Add Field descriptions and examples to JWK schema
  • Add summaries to all endpoints for cleaner Swagger UI
  • Improve health endpoint with proper response model

Changes

File Change
main.py Tags, servers, auth docs
schemas/jwk.py Field descriptions
routes/*.py Summaries for all endpoints
routes/health.py Proper response model

Test plan

  • All unit tests pass (79/79)
  • View Swagger UI at /docs and verify organization
  • Check server dropdown shows prod/dev URLs
  • Verify JWK schema shows field descriptions

@felippemsc felippemsc added the deploy-rc Deploys release candidate to dev environment label Feb 6, 2026
@github-actions
Copy link

github-actions bot commented Feb 6, 2026

🚀 Release Candidate Deployed!

Version: v0.0.22-rc.40

The RC has been deployed to the dev environment. Check the /health endpoint to verify.

@felippemsc felippemsc merged commit 876256f into main Feb 6, 2026
5 checks passed
@felippemsc felippemsc deleted the feat/swagger-improvements branch February 6, 2026 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy-rc Deploys release candidate to dev environment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant