Use this template when adding new endpoint documentation to the Brewski Docs wiki. Replace placeholder text and remove sections that do not apply.

• Endpoint Group: e.g. Orders / Payments
• Purpose: Single sentence explaining what the endpoint does.
• Availability: Public, Requires team membership, or Internal (internal endpoints must stay in the root README, not the wiki).

• Required scopes/roles.
• Any feature flags or plan entitlements needed.

• :id (uuid, required) — description.

• filter (string, optional, values: ...) — description.

• Authorization: Bearer <token> — describe when required.
• Content-Type: application/json

{
  "sampleField": "value",
  "optionalField": 123,
  "nested": {
    "flag": true
  }
}

• Document each field with type, requirement, validation limits, and default behaviour if omitted.

{
  "id": "uuid",
  "createdAt": "2025-02-06T12:00:00.000Z",
  "status": "example",
  "related": {
    "id": "uuid",
    "name": "Sample"
  }
}

• Explain derived values, computed flags, pagination metadata, etc.

• List database writes, emitted events, background jobs, or cache invalidations.

• Mention idempotency keys, rate buckets, or retry strategies when applicable.

• Provide curl example, client SDK snippet, or workflow diagram if useful.