Skip to content
Registry StackDocsLatest

Relay scenario catalog

View as Markdown

This catalog describes where Registry Relay fits in registry programs. It is a product and demo guide, not a REST specification.

Status labels:

StatusMeaning
SupportedWorks in the current Relay runtime with focused tests or demo coverage
Lab-supportedCan be shown with demo config or scripts, but still needs operator hardening
PartialImportant runtime pieces exist, with named gaps
PlannedNot yet supported
Out of scopeNot a Relay responsibility
PersonaWhat They Need
Registry stewardPublish protected consultation APIs without exposing source systems directly
Program systemRead the minimum registry data or aggregate needed for a service workflow
Planning analystQuery configured aggregates without enumerating sensitive rows
Metadata consumerDiscover datasets, schemas, policies, profiles, and standards surfaces
AuditorReconstruct who accessed what, for which purpose, and under which scope
Standards integratorConsume Relay through DCAT, OGC, SP DCI, or Registry Notary discovery contracts
SystemRole
Source registryOperational system of record, such as CSV, XLSX, Parquet, or PostgreSQL
Registry RelayRead-only gateway, metadata publisher, standards adapter, and audit emitter
Registry ManifestPortable metadata source used for static publication and runtime metadata
Registry NotaryClaim evaluation, evidence verification, credential issuance, and verification semantics
Service portal or case systemCalls Relay or Notary during a service workflow
Audit sinkReceives chained platform audit records
Standards consumerReads OGC, DCAT, SP DCI, Registry Notary discovery, or OpenAPI views
sequenceDiagram
  participant App as Program System
  participant Relay as Registry Relay
  participant Source as Source Registry
  participant Audit as Audit Sink

  App->>Relay: Authenticated metadata or row request
  Relay->>Relay: Check scope, filters, purpose, projection
  Relay->>Source: Read configured source
  Source-->>Relay: Source rows
  Relay->>Audit: Chained access record
  Relay-->>App: Filtered entity response
sequenceDiagram
  participant Analyst as Planning Analyst
  participant Relay as Registry Relay
  participant Source as Source Registry

  Analyst->>Relay: Discover aggregate structure and measures
  Analyst->>Relay: Execute configured aggregate
  Relay->>Source: Read bounded source data
  Relay->>Relay: Apply disclosure controls
  Relay-->>Analyst: JSON or CSV aggregate result
sequenceDiagram
  participant Steward as Registry Steward
  participant Manifest as Registry Manifest
  participant Relay as Registry Relay
  participant Consumer as Metadata Consumer

  Steward->>Manifest: Validate portable metadata
  Manifest-->>Steward: Static metadata bundle
  Steward->>Relay: Deploy runtime config bound to manifest
  Consumer->>Relay: Authenticated scoped metadata discovery
sequenceDiagram
  participant Client as Service Client
  participant Relay as Registry Relay
  participant Notary as Registry Notary

  Client->>Relay: Discover evidence offering metadata
  Relay-->>Client: Notary endpoint or discovery URL
  Client->>Notary: Submit claim or evidence request
  Notary-->>Client: Verification result or credential
#ScenarioPatternStatusMain Gap
1Case system reads a household record with required filtersProtected consultationSupportedClients must use the dataset-scoped V1 route shape
2Case system follows a dataset-local relationshipProtected consultationSupportedCross-dataset relationships remain client-composed
3Planning analyst runs district-level eligibility aggregatesAggregate-only planningSupportedPer-caller query budgets are not a V1 feature
4Operator publishes portable metadata separately from Relay runtimeMetadata publicationSupportedStatic publication is manual; no managed release process yet.
5Metadata consumer reads DCAT and SHACL viewsMetadata publicationSupportedProfile coverage depends on manifest quality
6Auditor traces row access through platform audit recordsGovernanceSupportedExternal audit storage is deployment-owned
7Client requests a signed credential from Registry Notary after Relay discoveryNotary handoffSupportedRelay publishes evidence offering discovery only
8Client discovers evidence offerings and calls Registry NotaryNotary handoffSupportedNotary request semantics live in Notary docs
9GIS consumer reads spatial entities through OGC API FeaturesStandards adapterSupportedRequires spatial config and feature build
10Catalog consumer reads metadata through OGC API RecordsStandards adapterSupportedRecords surface is metadata-only
11EDR consumer queries admin-area aggregatesStandards adapterLab-supportedRequires configured spatial aggregates and feature build
12SP DCI sync consumer calls a configured registry adapterStandards adapterLab-supportedAsync DCI APIs are out of scope
14Program system writes registry data through RelayWrite workflowOut of scopeRelay V1 is read-only
15Relay performs local evidence verificationEvidence verificationOut of scopeRegistry Notary owns verification execution
16Relay enforces row-level authorization expressionsFine-grained authPlannedV1 uses scopes, filters, purpose headers, and projection

The demo configs cover benefits casework, clinic capacity, education, public works, subject linkage, disability registry sync, and cross-demo workflows. Use them as scenario fixtures rather than as production policy.