Skip to content

[enhancement] E5-1: No OpenAPI specification β€” no machine-readable contractΒ #1438

@OneStepAt4time

Description

@OneStepAt4time

Finding

ID: API-3 | Severity: πŸ”΄ HIGH

No openapi.yaml or swagger.json. Hand-authored docs/api-reference.md only. No auto-generated SDKs, no API gateway compatibility, no request validation middleware from schemas.

Fix Required

  1. Generate or author openapi.yaml covering all /v1/ endpoints
  2. Use @fastify/swagger to auto-generate from Fastify schemas
  3. Publish spec to /v1/openapi.json and in docs/
  4. Add CI step to validate spec on every PR

Files: src/server.ts, new openapi.yaml, docs/api-reference.md

Acceptance Criteria

GET /v1/openapi.json returns a valid OpenAPI 3.1 document. swagger-cli validate passes in CI.

Milestone

M-E5: API & Integration

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions