Skip to content
Registry StackDocsDocumentation preview
Search

Metadata landing page

GET
/metadata
curl --request GET \
  --url https://data.example.test/metadata \
  --header 'Authorization: Bearer <token>'

Lists canonical metadata publication links and embeds the scoped metadata catalog.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json

Portable metadata landing document with links and an embedded scoped catalog.

object
key
additional properties
any
Examples
Examplemetadata_landing

Metadata landing page with scoped catalog links.

{
  "catalog": {
    "application_profiles": [],
    "base_url": "https://data.example.test",
    "conforms_to": [],
    "datasets": [
      {
        "access_rights": "restricted",
        "adms_status": "under_development",
        "applicable_legislation": [],
        "conforms_to": [
          "https://publicschema.org/concepts/Household",
          "https://schema.spdci.org/extensions/social/v1/Group"
        ],
        "dataset_id": "social_registry",
        "description": "Synthetic social registry used for OpenAPI contract generation.",
        "entities": {
          "household": {
            "concept_uri": "https://publicschema.org/concepts/Household",
            "description": "Registered household.",
            "fields": {
              "area_geometry": {
                "concepts": [],
                "constraints": {},
                "field_type": "string",
                "name": "area_geometry",
                "required": false
              },
              "id": {
                "concepts": [
                  "https://example.test/vocab/properties/householdId"
                ],
                "constraints": {},
                "field_type": "string",
                "name": "id",
                "required": true
              },
              "region": {
                "codelist_scheme_iri": "https://example.test/vocab/codelists/Region",
                "concepts": [
                  "https://example.test/vocab/properties/region"
                ],
                "constraints": {},
                "field_type": "string",
                "name": "region",
                "required": false
              }
            },
            "identifiers": [],
            "name": "household",
            "primary_key": "id",
            "relationships": [
              {
                "concept_uri": "https://example.test/vocab/relationships/householdMember",
                "foreign_key": "household_id",
                "kind": "has_many",
                "links": {
                  "target_schema": "https://data.example.test/metadata/schema/social_registry/individual/schema.json"
                },
                "name": "members",
                "target": "individual"
              }
            ],
            "title": "Household"
          },
          "individual": {
            "concept_uri": null,
            "description": "",
            "fields": {
              "age": {
                "concepts": [],
                "constraints": {},
                "field_type": "integer",
                "name": "age",
                "required": false
              },
              "household_id": {
                "concepts": [],
                "constraints": {},
                "field_type": "string",
                "name": "household_id",
                "required": true
              },
              "id": {
                "concepts": [],
                "constraints": {},
                "field_type": "string",
                "name": "id",
                "required": true
              }
            },
            "identifiers": [],
            "name": "individual",
            "primary_key": "id",
            "relationships": [
              {
                "foreign_key": "household_id",
                "kind": "belongs_to",
                "links": {
                  "target_schema": "https://data.example.test/metadata/schema/social_registry/household/schema.json"
                },
                "name": "household",
                "target": "household"
              }
            ],
            "title": "Individual"
          }
        },
        "evidence_offerings": {},
        "owner": "Social Ministry",
        "policy": {
          "assigner": "did:web:data.example.test",
          "permissions": [
            {
              "action": "odrl:use",
              "constraints": [],
              "duties": [],
              "target": "#dataset-social_registry"
            }
          ],
          "profile": [],
          "prohibitions": [],
          "uid": "#policy-social_registry-offer"
        },
        "sensitivity": "personal",
        "title": "Social Registry",
        "update_frequency": "monthly"
      }
    ],
    "description": "",
    "id": "registry-relay",
    "participant_id": "did:web:data.example.test",
    "profiles": [],
    "publisher": "Ministry of Delivery",
    "title": "Registry Relay API"
  },
  "links": [
    {
      "href": "/metadata",
      "rel": "self"
    },
    {
      "href": "/metadata/catalog",
      "rel": "describedby",
      "type": "application/json"
    },
    {
      "href": "/metadata/dcat",
      "rel": "alternate",
      "type": "application/ld+json"
    },
    {
      "href": "/metadata/dcat/bregdcat-ap",
      "rel": "alternate",
      "type": "application/ld+json"
    },
    {
      "href": "/metadata/shacl",
      "rel": "describedby",
      "type": "application/ld+json"
    },
    {
      "href": "/metadata/policies",
      "rel": "describedby",
      "type": "application/ld+json"
    }
  ]
}

401

Section titled “401”

Missing or invalid bearer credential.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

403

Section titled “403”

Authenticated principal lacks the scope required for this operation.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

default

Section titled “default”

Problem Details error response.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}