API references

View as Markdown

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 rendered as native documentation pages, so they follow the light and dark theme and are covered by site search.

Pinned sources

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

Registry Relay API

registry-relay

Owner: registry-relay
Status: pulled at the pinned ref (build artifact, regenerated each build). Use `GET /openapi.json` on a running gateway for the instance-specific shape of `{dataset_id}` and `{entity}`. Runtime deployments gate that route by default unless `openapi_requires_auth` is disabled for demos or controlled tooling.
Source: Pulled from `registry-relay/openapi/registry-relay.openapi.json` at the pinned ref in `src/data/repo-docs.yaml` by `scripts/fetch-openapi.mjs`. The repo authors an abstract contract that uses templated paths and capability tags, not a per-deployment dump.
Pinned artifact: openapi/registry-relay.openapi.json

Registry Notary API

registry-notary

Owner: registry-notary
Status: pulled at the pinned ref (build artifact, regenerated each build) with federation, OID4VCI, and response examples
Source: Pulled from `registry-notary/openapi/registry-notary.openapi.json` at the pinned ref in `src/data/repo-docs.yaml` by `scripts/fetch-openapi.mjs`. The repo generates the spec with `cargo run -p registry-notary-bin -- openapi`.
Pinned artifact: openapi/registry-notary.openapi.json

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

Per-project pages

Registry Relay API documents the Protected Registry Data API, metadata API, evidence offering discovery, 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 (/v1/datasets/{dataset_id}/entities/{entity}/records/...) 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, signed response credentials (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 GET /openapi.json from that gateway. Runtime deployments gate that route by default unless openapi_requires_auth is disabled for demos or controlled tooling.

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.