Kong · Schema

CreateScorecard

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	string	The human-readable name of the scorecard.
description	string
entity_selector	object
criteria	array
scorecard_template	string	The name of the scorecard template used to create the scorecard. Otherwise, `null`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateScorecard",
  "title": "CreateScorecard",
  "type": "object",
  "properties": {
    "name": {
      "description": "The human-readable name of the scorecard.",
      "type": "string",
      "example": "Incident Response"
    },
    "description": {
      "type": "string",
      "example": "Governs key metrics pertaining to teams' incident response practices.",
      "nullable": true
    },
    "entity_selector": {
      "$ref": "#/components/schemas/ScorecardEntitySelector"
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateScorecardCriteria"
      },
      "minItems": 1
    },
    "scorecard_template": {
      "description": "The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n",
      "type": "string",
      "example": "kong_best_practices",
      "enum": [
        "kong_best_practices",
        "service_documentation",
        "service_maturity",
        "security_and_compliance"
      ],
      "nullable": true,
      "x-speakeasy-unknown-values": "allow"
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "description",
    "entity_selector",
    "criteria",
    "scorecard_template"
  ]
}