ScorecardTemplate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScorecardTemplate",
  "title": "ScorecardTemplate",
  "description": "Representation of a scorecard template.",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/ScorecardTemplateName"
    },
    "display_name": {
      "type": "string",
      "example": "Kong Best Practices"
    },
    "description": {
      "type": "string",
      "example": "Best practices that we encourage users to follow when using other Konnect applications."
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScorecardTemplateCriteria"
      },
      "example": [
        {
          "template_name": "gateway_manager_error_rate",
          "template_parameters": {
            "relative_window": "30d"
          },
          "integration": "gateway_manager",
          "section_name": "Gateway Observability"
        },
        {
          "template_name": "gateway_manager_response_latency",
          "template_parameters": {
            "metric": "response_latency_p95",
            "relative_window": "30d"
          },
          "integration": "gateway_manager",
          "section_name": "Gateway Observability"
        },
        {
          "template_name": "gateway_manager_has_plugin",
          "template_parameters": {},
          "integration": "gateway_manager",
          "section_name": "Plugin Management"
        }
      ]
    }
  },
  "required": [
    "name",
    "display_name",
    "description",
    "criteria"
  ]
}