Public Gateway API: schemas

The request and response bodies of the operations in this API.

EdgeInvokeRequestDto

Property	Type	Required	Description
`executionContext`	object	yes	Per-invocation ExecutionContext envelope. The edge trusts ONLY its `environment.id` + optional `resource.ref` selectors; `subject`, org, classification and biome attestation are re-derived server-side.
`input`	object	yes	Capability input payload.
`ref`	string	yes	Capability ref to invoke.

Property	Type	Required	Description
`auditId`	string	yes	Audit entry id — always populated, including on denial.
`obligations`	array of object	yes	Policy obligations the caller must honour locally.
`output`	object	no	Capability output (omitted on denial).

Property	Type	Required	Description
`contentHash`	string	no	SHA-256 of the bytes. Also the ETag the delivery route serves, so a client can cache correctly across a re-provision.
`mediaType`	string	no	The DECLARED media type. A client must still honour the Content-Type the delivery actually returns; these are two statements about one file.
`purpose`	XemaBrandingAssetPurpose	yes	What this asset is for.
`url`	string	yes	Where the bytes are served — an http(s) URL, or a root-relative path served by whatever fronts this deployment.

What this asset is for.

Type: one of "logo", "favicon"

Property	Type	Required	Description
`favicon`	XemaBrandingAssetDto	no
`logo`	XemaBrandingAssetDto	no

Property	Type	Required	Description
`documentUrl`	string	yes	Absolute URL of this deployment's public product identity document.
`scope`	XemaBrandingScope	yes	Which identity the branding document describes. Always the deployment: this bootstrap is read before any organisation is known.

Which identity the branding document describes. Always the deployment: this bootstrap is read before any organisation is known.

Type: one of "deployment"

Property	Type	Required	Description
`name`	string	yes	The edge name: one lowercase token (`parseEdgeName`).

Property	Type	Required	Description
`apiBaseUrl`	string	yes	Single same-origin base for browser API traffic. Canonical service names are appended as path segments.
`branding`	XemaBrandingEndpointsDto	yes
`edge`	XemaEdgeEndpointsDto	yes
`identity`	XemaIdentityEndpointsDto	no	Browser sign-in bootstrap. Absent when the deployment ships no browser sign-in.
`revision`	string	yes	SHA-256 revision of the canonical bootstrap payload, excluding this field.
`schemaVersion`	one of `"1"`	yes	Closed bootstrap schema version.

Property	Type	Required
`baseUrl`	string	yes
`clientId`	string	yes
`realm`	string	yes

Property	Type	Required	Description
`assets`	XemaBrandingAssetsDto	no	Declared branding assets. Absent means this deployment declared none and a client uses its own — never that assets are disabled.
`configured`	boolean	yes	Has anybody declared a product identity for this installation? `false` is the resting state, NOT "branding off": every field below is then absent and a client renders its own default.
`description`	string	no	The search-result and link-preview description.
`legalName`	string	no	The legal entity named in the copyright line.
`productName`	string	no	The product name, as it is written everywhere.
`revision`	string	yes	SHA-256 revision of the canonical branding payload, excluding this field.
`schemaVersion`	one of `"1"`	yes	Closed public-branding schema version.
`scope`	XemaBrandingScope	yes	Which identity this document describes. Always the deployment: this surface is read before any organisation is known.
`supportUrl`	string	no	A support destination — an http(s) URL or a root-relative path. Absent means NO support link is rendered anywhere.
`tagline`	string	no	The positioning line. Short enough for a footer column.