API — <route or resource>

Replace this with one or two plain sentences, about 160 characters at most, saying what the page is for.

  • Status: Draft
  • Last updated: YYYY-MM-DD
  • Related ADRs: ADR-NNNN

Snapshot of the system as it stands today. Edit in place; never record what changed.

Endpoints

MethodPathPurposeAuth

METHOD /path

Purpose. One line.

Authorisation. Who may call it, and which content it may return — cross-reference content/docs/maintain/rbac/<slug>.mdx. If it is public, say what keeps private content out of it.

Request

{}
FieldTypeRequiredNotes

Responses

StatusMeaningBody
200
400Validation failed{ "error": { "code": "...", "message": "..." } }
401Not authenticated
403Authenticated but not permitted
404Not found, or hidden by permission

Notes. Caching and revalidation, content type, pagination, rate limits, side effects.

On this page