Flow
ServicesTemplate Service

API

HTTP endpoints, response envelope, and OpenAPI for the template service.

Discovery and ops

PathMethodNotes
/GETService discovery (enveloped)
/api-docsGETSwagger UI
/openapi.yaml, /openapi.jsonGETSpec from binary
/healthzGETLiveness
/readyzGETReadiness (Postgres ping)

Versioned API

PathMethodContract
/v1/domain1POSTCreate record; requires Idempotency-Key
/v1/domain1/{id}GETGet by UUID
/v1/domain2POSTCreate record; requires Idempotency-Key
/v1/domain2/{id}GETGet by UUID

Enveloped All /v1/* JSON uses the Response envelope: The template service wraps every JSON response in {header, payload}; accounting still returns bare bodies and RFC 9457 errors until the divergence is resolved..

Authorization is not wired in the template service yet — endpoints are open aside from Idempotency-Key on writes. Audit columns use a placeholder actor (system).

Headers

HeaderRequiredPurpose
Idempotency-KeyPOST onlyStable across retries
Content-TypePOSTapplication/json

OpenAPI

Generated from Go handler types and served at runtime. Merged platform spec excludes template today (DEPLOYED_SERVICES in the Makefile).

Source: services/template/openapi.yaml.

On this page