Skip to content
Registry StackDocsv0.13.0

Overview

Read-only data gateway exposing entity records, catalog metadata, and SHACL/DCAT-AP shapes for governed datasets.

Registry Relay API 0.13.0

Section titled “Registry Relay API 0.13.0”

Read-only HTTP gateway over governed datasets. Serves entity records, catalog metadata, and SHACL/DCAT-AP shapes, with API discovery through the RFC 9727 catalog endpoint.

Information

  • License: Apache-2.0
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/healthz
GET
/ready
GET
/.well-known/api-catalog
GET
/metadata
GET
/metadata/catalog
GET
/metadata/datasets
GET
/metadata/datasets/{dataset_id}
GET
/metadata/datasets/{dataset_id}/policy
GET
/metadata/dcat
GET
/metadata/dcat/{profile}
GET
/metadata/evidence-offerings
GET
/metadata/evidence-offerings/{offering_id}
GET
/metadata/policies
GET
/v1/datasets
GET
/v1/datasets/{dataset_id}
GET
/v1/datasets/{dataset_id}/aggregates
GET
/v1/datasets/{dataset_id}/aggregates/{aggregate_id}
GET
/v1/datasets/{dataset_id}/aggregates/{aggregate_id}/metadata
POST
/v1/datasets/{dataset_id}/aggregates/{aggregate_id}/query
GET
/v1/datasets/{dataset_id}/aggregates/{aggregate_id}/structure
GET
/v1/datasets/{dataset_id}/dimensions
GET
/v1/datasets/{dataset_id}/dimensions/{item_id}
GET
/v1/datasets/{dataset_id}/measures
GET
/v1/datasets/{dataset_id}/measures/{item_id}
GET
/v1/datasets/{dataset_id}/entities/{entity}/records
GET
/v1/datasets/{dataset_id}/entities/{entity}/records/{id}
GET
/v1/datasets/{dataset_id}/entities/{entity}/records/{id}/relationships/{relationship}
GET
/v1/datasets/{dataset_id}/entities/{entity}/schema
GET
/v1/consultations/{profile_id}
POST
/v1/consultations/{profile_id}/execute
POST
/admin/v1/datasets/{dataset_id}/tables/{table_id}/reload
GET
/docs
GET
/docs/scalar.js
GET
/metadata/datasets/{dataset_id}/entities
GET
/metadata/datasets/{dataset_id}/entities/{entity}
GET
/metadata/datasets/{dataset_id}/entities/{entity}/schema
GET
/metadata/datasets/{dataset_id}/entities/{entity}/shacl
GET
/metadata/ogc/records
GET
/metadata/ogc/records/{record_id}
GET
/metadata/profiles
GET
/metadata/profiles/{profile}
GET
/metadata/schema/{dataset_id}/{entity}/schema.json
GET
/metadata/shacl
GET
/openapi.json

Authentication

Section titled “Authentication”

apiKeyAuth

Section titled “apiKeyAuth”

Compatibility API-key header accepted by API-key deployments. Send exactly one primary credential channel: either this header or Authorization: Bearer. Requests containing both are rejected with the generic auth.multiple_credentials response before either credential is parsed or validated, without revealing whether either credential is valid.

Security scheme type: apiKey

Header parameter name: x-api-key

bearerAuth

Section titled “bearerAuth”

API key carried as Authorization: Bearer <key>. The gateway hashes the bearer with SHA-256 and matches the fingerprint resolved from config.auth.api_keys[*].fingerprint.

Security scheme type: http

consultationOidc

Section titled “consultationOidc”

OIDC/OAuth2 bearer JWT accepted only when its verified claims identify the configured consultation workload and it carries the selected consultation profile’s exact required scope.

Security scheme type: http

Bearer format: JWT