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

# Registry Relay

> Operator and adopter documentation for Registry Relay.

Registry Relay turns registry data you already hold, in spreadsheets or PostgreSQL, into protected, scoped, read-only HTTP APIs. Authorized callers read records over purpose-bound routes, and the gateway never widens reach at request time. Relay also publishes discovery metadata that points callers to a Registry Notary for claim and evidence verification.

New here? Start with the hosted walkthrough, then the first-run tutorials in Registry Docs:

- [See it live](https://docs.registrystack.org/start/see-it-live/): read a protected API and get a credential against a hosted lab, with zero install.
- [Publish a spreadsheet as a secured registry API](https://docs.registrystack.org/tutorials/publish-spreadsheet-secured-registry-api/)
- [Verify a claim from your registry API](https://docs.registrystack.org/tutorials/verify-claim-registry-api/)

The references describe supported behavior. Some links open the source repository on GitHub.

## Integrate

- [API guide](./api/): auth, scopes, filters, pagination, metadata caching, Problem Details, standards surfaces, and the admin route reference. The curated public OpenAPI surface lives in [openapi/registry-relay.openapi.json](https://github.com/registrystack/registry-stack/blob/d45761a0104bd3d9c2e4b4db391d4223f289bd44/crates/registry-relay/openapi/registry-relay.openapi.json) and the served `/docs` and `/openapi.json`.
- [Client integration guide](./client-integration/): caller behavior for auth, purpose headers, discovery, pagination, ETags, errors, retries, aggregates, and the Registry Notary handoff.
- [Call Relay from OpenFn](./openfn-relay-adaptor-guide/): use the Registry Stack OpenFn Relay adaptor for protected row reads, discovery, and aggregate queries.
- [Credential issuance migration](./provenance/): legacy Relay response-credential issuer config removal and the Registry Notary handoff.

## Operate

- [Configuration guide](./configuration/): YAML contract, auth, audit, source formats, Postgres, entities, OGC Features, SP DCI, aggregates, and Registry Notary evidence-offering discovery.
- [Operations runbook](./ops/): deployment, production hardening checklist, build and release, secret rotation, audit handling, reloads, probes, metrics, running with Registry Notary, and troubleshooting.
- [Portable metadata](./metadata/): manifest split, metadata CLI, static publication, ODRL policy metadata contract, Relay metadata routes, catalog validation, and boundary rules.
- [Standards adapter operator guide](./standards-adapter-operator-guide/): rollout checklist for OGC Features, OGC Records, OGC EDR, and SP DCI sync.
- [XLSX readiness contract](./xlsx-readiness-contract/): workbook rules for stable XLSX-backed registries.

## Understand

- [Relay scenario catalog](./relay-scenario-catalog/): personas, systems, reusable patterns, support status, and demo coverage.
- [Standards assumptions](./standards-assumptions/): what Relay publishes versus what downstream tools may infer.
- [Release notes](./release-notes/): versioned adopter-facing changes and known limits.

## Build and maintain

- [Development guide](https://github.com/registrystack/registry-stack/blob/d45761a0104bd3d9c2e4b4db391d4223f289bd44/crates/registry-relay/docs/development.md): local setup, verification commands, local IdP setup, project layout, OpenAPI release policy, platform compatibility gate, and contribution rules.
- [Security assurance](https://github.com/registrystack/registry-stack/blob/d45761a0104bd3d9c2e4b4db391d4223f289bd44/crates/registry-relay/docs/security-assurance.md): CI security gates, image publication and signing policy, and advisory baselines.
- [perf/README.md](https://github.com/registrystack/registry-stack/blob/d45761a0104bd3d9c2e4b4db391d4223f289bd44/crates/registry-relay/perf/README.md): local k6 and Criterion performance workflow.