amduat-api/registry/api-contract.schema.md
Carl Niklas Rydberg a4b501e48d federation
2026-01-21 19:51:26 +01:00

1 KiB

Schema: registry/api-contract.jsonl

Each line is one JSON object (JSONL). This mirrors the conventions described in vendor/amduat/registry/README.md.

Canonical descriptor digest

bytes_sha256 is the SHA-256 digest (lowercase hex) of the exact contract bytes as stored in the corresponding registry/*.json file.

Fields

  • registry (string, required): registry name, fixed to AMDUATD/API.
  • contract (string, required): contract series identifier (e.g. AMDUATD/API/1).
  • handle (string, required): stable handle (e.g. amduat.api.amduatd.contract.v1@1).
  • media_type (string, required): content type of the bytes (e.g. application/json).
  • status (string, required): active | deprecated | reserved.
  • bytes_sha256 (string, required): sha256 of the bytes file.
  • notes (string, optional): human notes.

Contract Notes

  • amduatd-api-contract.v1.json includes optional receipt v1.1 fields for /v1/pel/run and may emit receipt_ref in responses.
  • /v1/fed/records supports limit for paging (default 256, max 10000).