API references

Use this section to browse the HTTP API for Registry Relay or Registry Notary. Each page is built from a pinned OpenAPI artifact owned by the project it describes.

Generated API reference pages are published using Redoc.

Pinned sources

The table below shows the current artifact status, source generator, and link to each Redoc page. The table is generated from src/data/openapi-sources.yaml.

Registry Relay API

registry-relay

Owner

registry-relay

Status

hand-authored abstract contract (templated paths and capability tags, not a per-deployment dump). Use the auth-gated `GET /openapi.json` on a running gateway for the instance-specific shape of `{dataset_id}` and `{entity}`.

Source

Hand-authored abstract contract in `registry-relay/openapi/registry-relay.openapi.json`, cross-checked against `registry-relay/docs/api.md` and the runtime route table.

Pinned artifact

openapi/registry-relay.openapi.json

Open Redoc page

Registry Notary API

registry-notary

Owner

registry-notary

Status

pinned generated snapshot from the local Registry Notary workspace with federation, OID4VCI, and response examples

Source

`cargo run -p registry-notary-bin -- openapi`

Pinned artifact

openapi/registry-notary.openapi.json

Open Redoc page

Generated from src/data/openapi-sources.yaml.

Per-project pages

• Registry Relay API documents the Protected Registry Data API, metadata API, evidence offering verification, health and readiness endpoints, and optional standards adapters.
• Registry Notary API documents the claim discovery, evaluation, batch evaluation, rendering, JWKS, service discovery, and credential issuance endpoints.

Provenance and freshness

Registry Relay ships a hand-authored abstract OpenAPI contract. It documents the full route surface using templated paths (/datasets/{dataset_id}/{entity}/...) and capability tags, rather than enumerating one deployment’s datasets and entities. The contract lives in registry-relay/openapi/registry-relay.openapi.json and is cross-checked against registry-relay/docs/api.md and the runtime route table. Feature-gated surfaces (OGC API Features, OGC API Records, OGC API EDR, SP DCI, provenance, VC-JWT) are included with notes in each tag description explaining the build feature that mounts them. For the instance-specific shape of {dataset_id} and {entity} in a given deployment, fetch the auth-gated GET /openapi.json from that gateway.

Registry Notary generates its OpenAPI document via a subcommand:

cargo run -p registry-notary-bin -- openapi > openapi/registry-notary.openapi.json

Regenerate and re-pin the artifact when the Notary API changes.