Kong · Schema

CriteriaTemplate

Representation of a criteria template.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	object
display_name	string	The human-readable display name of the template.
category	string	Categorical tag for the functionality the template relates to.
template_string	string	[Liquid](https://shopify.github.io/liquid/) template string used to render the criteria interpolated by parameters.
integration_name	string	The catalog integration who registered the given criteria template. This will be `null` when a template is always available independent of connected integrations.
installed	boolean	Whether the template is available given the current state of the catalog. For example, this will be `false` when the template is provided by an integrastion that is not currently connected.
schema	object
required_integration_capability	string	Required capability from connected integrations to use this criteria template. Applicable for templates that are not provided by a given integration (functional across integrations).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CriteriaTemplate",
  "title": "CriteriaTemplate",
  "description": "Representation of a criteria template.",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/CriteriaTemplateName"
    },
    "display_name": {
      "description": "The human-readable display name of the template.",
      "type": "string"
    },
    "category": {
      "description": "Categorical tag for the functionality the template relates to.",
      "type": "string",
      "example": "Source Code Management",
      "enum": [
        "Source Code Management",
        "Incident Management",
        "Observability",
        "Code Quality",
        "Issue Tracking",
        "Communications",
        "Feature Management",
        "Security / Vulnerability",
        "Documentation",
        "Catalog Management",
        "Gateway Configuration"
      ],
      "nullable": true,
      "x-speakeasy-unknown-values": "allow"
    },
    "template_string": {
      "description": "[Liquid](https://shopify.github.io/liquid/) template string used to render the criteria interpolated by parameters.",
      "type": "string",
      "nullable": true
    },
    "integration_name": {
      "description": "The catalog integration who registered the given criteria template.\nThis will be `null` when a template is always available independent of connected integrations.\n",
      "type": "string",
      "nullable": true
    },
    "installed": {
      "description": "Whether the template is available given the current state of the catalog.\nFor example, this will be `false` when the template is provided by an integrastion\nthat is not currently connected.\n",
      "type": "boolean"
    },
    "schema": {
      "$ref": "#/components/schemas/CriteriaTemplateSchema"
    },
    "required_integration_capability": {
      "description": "Required capability from connected integrations to use this criteria template.\nApplicable for templates that are not provided by a given integration (functional\nacross integrations).\n",
      "type": "string",
      "enum": [
        null,
        "on_call_provider",
        "incident_provider",
        "pull_request_provider",
        "workflow_provider"
      ],
      "nullable": true,
      "x-speakeasy-unknown-values": "allow"
    }
  },
  "required": [
    "name",
    "display_name",
    "category",
    "template_string",
    "integration_name",
    "installed",
    "schema",
    "required_integration_capability"
  ]
}