Developer
c8db6ce933
- Change mobile terminal CSS to use touch-action: none and overscroll-behavior: none so the custom touch handler owns swipes - Archive completed/partial OpenSpec specs to openspec/changes/archive/2026-06-14-completed-specs-archive/ - Regenerate project maps Quality gates: npm run typecheck, npm run lint (apps/web)
22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# 2026-05-19-api-documentation
|
|
dir: 2026-05-19-api-documentation
|
|
|
|
index: 2026-05-19-api-documentation/.pi-map.index.md
|
|
|
|
## role
|
|
Planning and design documents for improving API documentation in a FastAPI-based application.
|
|
## files
|
|
- design.md | Design document outlining API documentation structure, health endpoints, and OpenAPI enhancements for a FastAPI-based application | dep: FastAPI, Pydantic v2, psutil, SQLAlchemy, PostgreSQL, Docker
|
|
- proposal.md | Proposes a comprehensive API documentation improvement plan for a FastAPI-based project | dep: FastAPI, OpenAPI/Swagger, ReDoc, Pydantic, apps/api/README.md, docs/architecture/decisions/
|
|
- tasks.md | Project task tracking document for API documentation improvements across health endpoints, endpoint documentation, model documentation, README creation, architecture decisions, and quality gates
|
|
## arch
|
|
Documentation-driven development with structured markdown specifications covering OpenAPI enhancements, health endpoint standards, and phased task tracking for documentation quality gates.
|
|
## tags
|
|
documentation, api, fastapi, design, document, health, endpoints, openapi
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|