provider_check_schema_get

Fetch check schema details (params/result/comparators) for a provider.

Key notes

• Returns compiled schema metadata for a single check.
• Includes comparator allow-lists and check examples.
• Subject to provider disclosure policy and authz.

Inputs

• check_id (required): Provider check identifier.
• provider_id (required): Provider identifier.

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "check_id": {
      "description": "Provider check identifier.",
      "type": "string"
    },
    "provider_id": {
      "description": "Provider identifier.",
      "type": "string"
    }
  },
  "required": [
    "provider_id",
    "check_id"
  ],
  "type": "object"
}

Outputs

• allowed_comparators (required): Comparator allow-list for this check.
• anchor_types (required): Anchor types emitted by this check.
• check_id (required): Check identifier.
• content_types (required): Content types for check output.
• contract_hash (required): Type: object.
• determinism (required): Determinism classification for provider checks.
• examples (required): Type: array.
• params_required (required): Whether params are required for this check.
• params_schema (required): JSON schema for check params.
• provider_id (required): Provider identifier.
• result_schema (required): JSON schema for check result value.

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "allowed_comparators": {
      "description": "Comparator allow-list for this check.",
      "items": {
        "description": "Comparator applied to evidence values.",
        "enum": [
          "equals",
          "not_equals",
          "greater_than",
          "greater_than_or_equal",
          "less_than",
          "less_than_or_equal",
          "lex_greater_than",
          "lex_greater_than_or_equal",
          "lex_less_than",
          "lex_less_than_or_equal",
          "contains",
          "in_set",
          "deep_equals",
          "deep_not_equals",
          "exists",
          "not_exists"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "anchor_types": {
      "description": "Anchor types emitted by this check.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "check_id": {
      "description": "Check identifier.",
      "type": "string"
    },
    "content_types": {
      "description": "Content types for check output.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "contract_hash": {
      "additionalProperties": false,
      "properties": {
        "algorithm": {
          "enum": [
            "sha256"
          ],
          "type": "string"
        },
        "value": {
          "description": "Lowercase hex digest.",
          "type": "string"
        }
      },
      "required": [
        "algorithm",
        "value"
      ],
      "type": "object"
    },
    "determinism": {
      "description": "Determinism classification for provider checks.",
      "enum": [
        "deterministic",
        "time_dependent",
        "external"
      ],
      "type": "string"
    },
    "examples": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "Short example description.",
            "type": "string"
          },
          "params": {
            "description": "Example params payload.",
            "type": [
              "null",
              "boolean",
              "number",
              "string",
              "array",
              "object"
            ]
          },
          "result": {
            "description": "Example result value.",
            "type": [
              "null",
              "boolean",
              "number",
              "string",
              "array",
              "object"
            ]
          }
        },
        "required": [
          "description",
          "params",
          "result"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "params_required": {
      "description": "Whether params are required for this check.",
      "type": "boolean"
    },
    "params_schema": {
      "description": "JSON schema for check params.",
      "type": [
        "null",
        "boolean",
        "number",
        "string",
        "array",
        "object"
      ]
    },
    "provider_id": {
      "description": "Provider identifier.",
      "type": "string"
    },
    "result_schema": {
      "description": "JSON schema for check result value.",
      "type": [
        "null",
        "boolean",
        "number",
        "string",
        "array",
        "object"
      ]
    }
  },
  "required": [
    "provider_id",
    "check_id",
    "params_required",
    "params_schema",
    "result_schema",
    "allowed_comparators",
    "determinism",
    "anchor_types",
    "content_types",
    "examples",
    "contract_hash"
  ],
  "type": "object"
}

Examples

Fetch check schema details for a provider.

Input:

{
  "check_id": "path",
  "provider_id": "json"
}

Output:

{
  "allowed_comparators": [
    "equals",
    "in_set",
    "exists",
    "not_exists"
  ],
  "anchor_types": [],
  "check_id": "path",
  "content_types": [
    "application/json"
  ],
  "contract_hash": {
    "algorithm": "sha256",
    "value": "5c3a5b6bce0f4a2c9e22c4fa6a1e6d8d90b0f2dfed1b7f1e9b3d3b3d1f0c9b21"
  },
  "determinism": "external",
  "examples": [],
  "params_required": true,
  "params_schema": {
    "properties": {
      "file": {
        "type": "string"
      },
      "jsonpath": {
        "type": "string"
      }
    },
    "required": [
      "file"
    ],
    "type": "object"
  },
  "provider_id": "json",
  "result_schema": {
    "type": [
      "null",
      "string",
      "number",
      "boolean",
      "array",
      "object"
    ]
  }
}