Summary
Render a static version of the OpenAPI/REST API documentation on the public docs site, complementing the runtime Scalar UI served by Litestar.
Context
- Litestar already auto-generates OpenAPI 3.1.0 schemas and serves Scalar UI at runtime (
/api/docs)
- This is for users who want to browse the REST API without running the server
- The Python library API reference (classes, functions) is already handled by mkdocstrings
Tasks
Notes
- Lower priority — useful when there's a hosted demo instance
- For now, docs link to "API docs available at
/api/docs when running the server"
- See ADR-003 for documentation architecture decisions
Summary
Render a static version of the OpenAPI/REST API documentation on the public docs site, complementing the runtime Scalar UI served by Litestar.
Context
/api/docs)Tasks
openapi.jsonat build time (via a script that starts the Litestar app and extracts the schema)mkdocs-render-swagger-pluginor embed Scalar/Redoc HTMLNotes
/api/docswhen running the server"