We're considering adding a feature to visually indicate the maintenance status of each endpoint directly within the auto-generated FastAPI docs (/docs and/or /redoc), using badges like ✅ ON / ❌ OFF.
Goals
- Help developers quickly see which endpoints are currently under maintenance.
- Improve developer experience when testing or exploring APIs via the documentation.
Proposal
- Inject custom OpenAPI metadata or use route-level tags/extensions.
- Modify Swagger UI and/or ReDoc rendering to display ON/OFF status per endpoint.
- Reuse existing maintenance decorators/config to read and reflect the current status (no toggling/changing functionality involved).
Open Questions
- Best way to inject this info cleanly into OpenAPI schema?
- ReDoc and Swagger UI may require different approaches. Any preference?
Let's use this thread to brainstorm implementation ideas and track progress.
We're considering adding a feature to visually indicate the maintenance status of each endpoint directly within the auto-generated FastAPI docs (
/docsand/or/redoc), using badges like ✅ ON / ❌ OFF.Goals
Proposal
Open Questions
Let's use this thread to brainstorm implementation ideas and track progress.