schemas_list

List registered data shapes for a tenant and namespace.

Key notes

• Requires tenant_id and namespace_id.
• Supports pagination via cursor + limit.

Inputs

• cursor (optional): One of 2 schema variants.
• limit (optional): Maximum number of records to return.
• namespace_id (required): Namespace identifier.
• tenant_id (required): Tenant identifier.

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "cursor": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "description": "Pagination cursor.",
          "type": "string"
        }
      ]
    },
    "limit": {
      "description": "Maximum number of records to return.",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    },
    "namespace_id": {
      "description": "Namespace identifier.",
      "minimum": 1,
      "type": "integer"
    },
    "tenant_id": {
      "description": "Tenant identifier.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "tenant_id",
    "namespace_id"
  ],
  "type": "object"
}

Outputs

• items (required): Type: array.
• next_token (required): One of 2 schema variants.

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "created_at": {
            "oneOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "kind": {
                    "const": "unix_millis"
                  },
                  "value": {
                    "type": "integer"
                  }
                },
                "required": [
                  "kind",
                  "value"
                ],
                "type": "object"
              },
              {
                "additionalProperties": false,
                "properties": {
                  "kind": {
                    "const": "logical"
                  },
                  "value": {
                    "minimum": 0,
                    "type": "integer"
                  }
                },
                "required": [
                  "kind",
                  "value"
                ],
                "type": "object"
              }
            ]
          },
          "description": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "description": "Optional schema description.",
                "type": "string"
              }
            ]
          },
          "namespace_id": {
            "description": "Namespace identifier.",
            "minimum": 1,
            "type": "integer"
          },
          "schema": {
            "description": "JSON Schema payload.",
            "type": [
              "null",
              "boolean",
              "number",
              "string",
              "array",
              "object"
            ]
          },
          "schema_id": {
            "description": "Data shape identifier.",
            "type": "string"
          },
          "signing": {
            "additionalProperties": false,
            "properties": {
              "algorithm": {
                "default": null,
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "description": "Signature algorithm label.",
                    "type": "string"
                  }
                ]
              },
              "key_id": {
                "description": "Signing key identifier.",
                "type": "string"
              },
              "signature": {
                "description": "Schema signature string.",
                "type": "string"
              }
            },
            "required": [
              "key_id",
              "signature"
            ],
            "type": "object"
          },
          "tenant_id": {
            "description": "Tenant identifier.",
            "minimum": 1,
            "type": "integer"
          },
          "version": {
            "description": "Data shape version identifier.",
            "type": "string"
          }
        },
        "required": [
          "tenant_id",
          "namespace_id",
          "schema_id",
          "version",
          "schema",
          "description",
          "created_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next_token": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "description": "Pagination token for the next page.",
          "type": "string"
        }
      ]
    }
  },
  "required": [
    "items",
    "next_token"
  ],
  "type": "object"
}

Examples

List data shapes for a namespace.

Input:

{
  "cursor": null,
  "limit": 50,
  "namespace_id": 1,
  "tenant_id": 1
}

Output:

{
  "items": [
    {
      "created_at": {
        "kind": "unix_millis",
        "value": 1710000000000
      },
      "description": "Asserted payload schema.",
      "namespace_id": 1,
      "schema": {
        "additionalProperties": false,
        "properties": {
          "deploy_env": {
            "type": "string"
          }
        },
        "required": [
          "deploy_env"
        ],
        "type": "object"
      },
      "schema_id": "asserted_payload",
      "tenant_id": 1,
      "version": "v1"
    }
  ],
  "next_token": null
}