HTTP API (internal)

Engineering-facing API reference organized by resource: each resource has a hub page (business context, data contract, links to methods), and each operationId has its own page so readers are not overloaded with a single endless scroll.

Resources

  • User — identity under /api/v1/user; the resource hub is the single entry point (business context, contract summary, technical depth); per-method pages link back to anchors on that page.
  • ConspectusETR study note under /api/v1/conspectuses (plus related /schedule/summary and /errors); the resource hub explains the entity, field mapping, API surface, and links to per-method pages under conspectus/operations/ (same pattern as User).

Add a new list entry here when another router gains an internal hub.

External contract

Paths, schemas, and declared errors: docs/openapi/openapi-baseline.json and OpenAPI (test). Internal pages add narrative and operational semantics per ADR 0025.

Page history

Date Change Author
Added Page history section (repository baseline). Ivan Boyarkin