Kong · Schema

ScorecardCriteria

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string
name string Override display name for the criteria, for greater contextual clarity within a given scorecard.
scorecard_id string
integration string The integration `name` when it provides the criteria template. Otherwise `null`.
enabled boolean Whether the criteria is enabled for the given scorecard.
template_name object
template_parameters object
section_name string Organizational section name for the criteria within the scorecard.
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

kong-scorecardcriteria-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScorecardCriteria",
  "title": "ScorecardCriteria",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "5c1121f9-3f3a-47c7-9bb6-c81a51128714"
    },
    "name": {
      "description": "Override display name for the criteria, for greater contextual clarity within a given scorecard.",
      "type": "string",
      "example": "Time to restore service is less than 6 hours over the last 3 months.",
      "nullable": true
    },
    "scorecard_id": {
      "type": "string",
      "format": "uuid",
      "example": "f3704e4c-104d-4f21-998a-20d4364c893f"
    },
    "integration": {
      "description": "The integration `name` when it provides the criteria template. Otherwise `null`.",
      "type": "string",
      "example": null,
      "nullable": true
    },
    "enabled": {
      "description": "Whether the criteria is enabled for the given scorecard.",
      "type": "boolean",
      "example": true
    },
    "template_name": {
      "$ref": "#/components/schemas/CriteriaTemplateName"
    },
    "template_parameters": {
      "$ref": "#/components/schemas/CriteriaParameters"
    },
    "section_name": {
      "description": "Organizational section name for the criteria within the scorecard.",
      "type": "string",
      "example": "Documentation",
      "maxLength": 120,
      "minLength": 1,
      "nullable": true
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "required": [
    "id",
    "name",
    "scorecard_id",
    "integration",
    "enabled",
    "template_name",
    "template_parameters",
    "section_name",
    "created_at",
    "updated_at"
  ]
}