Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/llms.txt
Full corpus: https://docs.registrystack.org/llms-full.txt

# API references

> Generated API reference pages for Registry Relay and Registry Notary, built from pinned OpenAPI artifacts.

import OpenApiSourcesTable from '../../../../components/OpenApiSourcesTable.astro';

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.

{/* Do not duplicate endpoint reference content in narrative pages. */}

## 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`.

<OpenApiSourcesTable />

## Per-project pages

- [Registry Relay API](./registry-relay/) documents the Protected Registry Data API, metadata API,
  evidence offering discovery, health and readiness endpoints, and optional standards adapters.
- [Registry Notary API](./registry-notary/) documents the claim discovery, evaluation, batch
  evaluation, rendering, JWKS, service discovery, and credential issuance endpoints.

## Provenance and freshness

[Registry Relay](../../products/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`.
Feature-gated surfaces (OGC API Features, OGC API Records, OGC API EDR, and SP DCI) 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](../../products/registry-notary/) generates its OpenAPI document via a subcommand:

```sh
cargo run -p registry-notary -- openapi > openapi/registry-notary.openapi.json
```

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