API Contract

This document defines the normative API surface for the standard.

HTTP API

• The OpenAPI specification in api/spec/openapi.yaml is normative.
• Implementations MUST expose the HTTP endpoints defined in the OpenAPI spec, including:
  • /v1/accounts
  • /v1/mint
  • /v1/transfer
  • /v1/ledger/transactions
  • /v1/ledger/entries
  • /healthz, /readyz, /metrics
• Implementations MUST serve the OpenAPI document at /openapi.yaml.

gRPC API

• Protobuf definitions in api/proto/ are normative for gRPC services.
• Implementations MUST expose the services and message semantics defined in those protobuf files.

Versioning

• HTTP endpoints MUST be versioned under a stable prefix (e.g., /v1).
• gRPC service versions MUST be encoded in the protobuf package names.
• Backward compatibility rules are defined in STANDARD/COMPATIBILITY.md.