Skip to Content
OpenAPI Spec

OpenAPI Specification

A complete, machine-readable OpenAPI 3.x document is generated from the live routes and the scope registry, so it never drifts from the running API.

Download

https://dperspective.galacticgeeks.com/openapi.json
curl https://dperspective.galacticgeeks.com/openapi.json -o dperspective-openapi.json

Import it into your client generator, Postman, Insomnia, or any OpenAPI tool.

What it contains

For every served operation, the document describes:

  • the versioned path under /api/v1,
  • the HTTP method and parameters,
  • request and per-status response schemas,
  • the single required scope (as a per-endpoint OAuth2 security requirement),
  • the set of error codes the operation can return.

A components section enumerates every defined scope as an OAuth2 security scheme (authorization-code + client-credentials flows) and defines the shared Error_Envelope schema.

The spec is generated from the same route metadata that powers the live API, and a built-in conformance check guarantees the documented surface and the served routes never silently diverge.

Security schemes

  • authorizationCode — grants user-scoped, consent-gated PHI access. Each endpoint advertises the single scope it requires.
  • clientCredentials — grants non-PHI access only.