Skip to content

SchemaBundle

GET /schemas — one self-contained document describing the delivered shape of every Contract reachable in the calling key’s environment, keyed {contractId}@{version} under $defs, $ref-resolvable only within this same document (never a separate fetch per Contract).

readonly $defs: Record<string, JsonSchemaNode>


readonly $id: string


readonly optional x-deliveryMode?: string

Which delivery mode these schemas describe. 'server-resolve' — the only value a server sends today — means every field is the shape a request carrying a ctx bag and no raw receives. A client-resolve request (no ctx) instead gets the unresolved variant-set envelope for each field the bundle marks x-personalizable, and raw=true the locale envelope for each x-localizable one; neither is described here.

Optional because a server older than the annotation sends none — consumers should treat its absence as “unstated” rather than assuming a mode.