MASTER_BRIEF originally specified OpenAPI codegen, but `openapi.yaml` is incomplete until Phase 2. Developers still need endpoint docs for implemented Phase 1 routes (health, auth validate, proxy chat stub). Manual `<Endpoint>` pages prevent shipping empty API Reference sidebar links.
Milestone D.3.4 — API reference (manual Phase 1)
Status: Complete (#123)
Goal: D.3
Phase: 1.5 — Docs Site
Wave: 9
Estimated effort: 1 day
ADR required: None (manual API; OpenAPI codegen deferred to Phase 2)
Spec detail: MASTER_BRIEF.md Part D (D.3.4).
Why This Milestone Exists
MASTER_BRIEF originally specified OpenAPI codegen, but openapi.yaml is incomplete until Phase 2. Developers still need endpoint docs for implemented Phase 1 routes (health, auth validate, proxy chat stub).
Manual <Endpoint> pages prevent shipping empty API Reference sidebar links.
D.3.4-manual is explicitly scoped to CURRENT_STATE implemented surface — no Phase 2 endpoints.
Non-Goals
- fumadocs-openapi codegen from missing spec
- Documenting unimplemented REST resources
- Porting full 2500-line API_DOCUMENTATION.md wholesale
Branch
feat/d3-4-api-manual
PR Title
docs(docs): manual Phase 1 API reference (D.3.4)
Prerequisites
- D.3.3 merged
Deliverables
- Manual MDX pages under
content/docs/api-reference/for Phase 1 endpoints only - Each page uses
<Endpoint method="…" path="…" />component - Parameters, example 200/4xx/5xx responses from service READMEs
- Errors page covering proxy/auth error codes
See MASTER_BRIEF Part D (D.3.4) for full acceptance detail.
Files Affected
| File Path | Action | Notes |
|---|---|---|
docs/app/content/docs/api-reference/**/*.mdx | Add/Modify | Manual endpoint pages |
docs/API_DOCUMENTATION.md | Reference | Phase 1 banner section only |
Testing Requirements
verifyApiRef_MatchesCurrentState: Every documented endpoint exists in CURRENT_STATEverifyApiRef_NoPhase2Endpoints: No pages for unimplemented routesverifyApiRef_EndpointComponent: Each page renders Endpoint badge correctly
Acceptance Criteria
- All implemented Phase 1 proxy/auth endpoints appear in sidebar
- Each endpoint page shows method, path, and example responses
- No Phase 2-only endpoints documented as shipped
Risks
| Risk | Probability | Impact | Mitigation |
|---|---|---|---|
| Docs diverge when Phase 2 adds OpenAPI | High | Medium | Add banner linking to Phase 2 openapi milestone |
| Wrong HTTP status documented | Medium | High | Verify against running proxy in dev-smoke |
| Sidebar label still says "generated from OpenAPI" | Low | Medium | Update D.3.1 meta.json title if needed |
Last updated on