Summary
Add an OpenAPI 3.1 spec for all API endpoints and serve interactive docs via Swagger UI.
Motivation
An OpenAPI spec signals production readiness and enables:
- Auto-generated client SDKs (Python, TypeScript, etc.)
- Interactive API explorer at
/docs
- Import into Postman, Insomnia, and other tools
- Accurate documentation that stays in sync with code
Endpoints to document
| Method |
Path |
Description |
| POST |
/v1/dedupe |
Deduplicate chunks |
| POST |
/v1/dedupe/stream |
SSE streaming dedup |
| POST |
/v1/retrieve |
Query vector DB with dedup |
| GET |
/health |
Health check |
| GET |
/metrics |
Prometheus metrics |
Deliverables
Acceptance Criteria
Summary
Add an OpenAPI 3.1 spec for all API endpoints and serve interactive docs via Swagger UI.
Motivation
An OpenAPI spec signals production readiness and enables:
/docsEndpoints to document
/v1/dedupe/v1/dedupe/stream/v1/retrieve/health/metricsDeliverables
openapi.yamlat repo rootGET /docs(embed viaswaggo/http-swaggeror static HTML)Acceptance Criteria
GET /docsrenders interactive API explorerswagger-cli validate