Skip to main content

Coverage policy

Route documentation status uses:
  • Publish: documented in OpenAPI/domain pages for public contributors.
  • Publish with redaction: documented behavior/RBAC without sensitive internal details.
  • Exclude: intentionally omitted from public docs.
  • Shipped, OpenAPI pending: implemented in d-sports-api and consumed by clients, but not yet in openapi.json.

Publish/Redact/Exclude matrix

Missing-route tracking

Current intentional gaps in generated OpenAPI are admin/debug/internal operations, the separate team-access freeze, catch-alls, staff-only POST /featured / POST /promos, and GET /api/user/all until d-sports-api#738 merges. Public and authenticated client routes are published, including starred HQ teams, the locker-singularity ledger, and canonical /api/v1/engage quest and Rep paths. PUT /api/packs/{id}/purchase is in the spec as removed (410). POST /api/games/daily-spin/reward is in the spec as deprecated. Curated domain pages cover approved admin/team routes without exposing sensitive internals.

Review cadence

  • Reconcile this matrix with d-sports-api/app/api/**/route.ts after every backend route expansion.
  • Update domain guides and navigation in the same PR as route additions when possible.
  • After bun run sync-openapi, confirm new OpenAPI paths have a domain-guide home.