-
Notifications
You must be signed in to change notification settings - Fork 0
docs: static OpenAPI reference for public docs site #296
Copy link
Copy link
Closed
Labels
prio:lowNice to have, can deferNice to have, can deferscope:smallLess than 1 day of workLess than 1 day of worktype:docsDocumentation workDocumentation work
Description
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
- Export
openapi.jsonat build time (via a script that starts the Litestar app and extracts the schema) - Render static OpenAPI docs using
mkdocs-render-swagger-pluginor embed Scalar/Redoc HTML - Add REST API section to MkDocs nav
- Link between static docs and runtime Scalar instance
Notes
- Lower priority — useful when there's a hosted demo instance
- For now, docs link to "API docs available at
/api/docswhen running the server" - See ADR-003 for documentation architecture decisions
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
prio:lowNice to have, can deferNice to have, can deferscope:smallLess than 1 day of workLess than 1 day of worktype:docsDocumentation workDocumentation work