Kong · Schema

CatalogServiceScorecard

Representation of a scorecard.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string
name string The human-readable name of the scorecard.
description string
score object
entity_selector object
scorecard_template string The name of the scorecard template used to create the scorecard. Otherwise, `null`.
created_at object
updated_at object
criteria array
View JSON Schema on GitHub

JSON Schema

kong-catalogservicescorecard-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogServiceScorecard",
  "title": "CatalogServiceScorecard",
  "description": "Representation of a scorecard.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "f3704e4c-104d-4f21-998a-20d4364c893f"
    },
    "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
    },
    "score": {
      "$ref": "#/components/schemas/ScorecardScore"
    },
    "entity_selector": {
      "$ref": "#/components/schemas/ScorecardEntitySelector"
    },
    "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"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CatalogServiceScorecardCriteria"
      }
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "score",
    "entity_selector",
    "scorecard_template",
    "created_at",
    "updated_at",
    "criteria"
  ]
}