Kong · Schema

ScorecardCriteriaServiceEvaluation

Evaluation for a scorecard criteria relative to the given service service. Has a `null` value when the criteria has not yet been evaluated for the service.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
is_passing boolean Whether or not the service has most recently passed the criteria check.
evaluation_context object
evaluation_error object Details about an error that occurred during evaluation preventing computation of a pass/fail result. Will be `null` when no error occurred.
attempted_at string The timestamp denoting the last evaluation attempt of the criteria for the service.
successfully_evaluated_at string The timestamp denoting when the criteria was last successfully evaluated for the service. Error states preventing the evaluation from being performed will not update this timestamp.
created_at object
View JSON Schema on GitHub

JSON Schema

kong-scorecardcriteriaserviceevaluation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScorecardCriteriaServiceEvaluation",
  "title": "ScorecardCriteriaServiceEvaluation",
  "description": "Evaluation for a scorecard criteria relative to the given service service.\nHas a `null` value when the criteria has not yet been evaluated for the service.\n",
  "type": "object",
  "properties": {
    "is_passing": {
      "description": "Whether or not the service has most recently passed the criteria check.",
      "type": "boolean"
    },
    "evaluation_context": {
      "$ref": "#/components/schemas/CriteriaEvaluationResultDetails"
    },
    "evaluation_error": {
      "description": "Details about an error that occurred during evaluation preventing computation of a pass/fail result.\nWill be `null` when no error occurred.\n",
      "type": "object",
      "example": null,
      "nullable": true,
      "properties": {
        "type": {
          "description": "The type of error that occurred.",
          "type": "string",
          "example": "integration_unauthorized"
        },
        "details": {
          "description": "Human-readable error message about the error.",
          "type": "string",
          "example": "The GitHub integration is unauthorized. Please ensure that the\nintegration is re-authorized for the criteria to be successfully evaluated.\n"
        }
      },
      "required": [
        "type",
        "details"
      ]
    },
    "attempted_at": {
      "description": "The timestamp denoting the last evaluation attempt of the criteria for the service.",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-15T07:20:50Z"
    },
    "successfully_evaluated_at": {
      "description": "The timestamp denoting when the criteria was last successfully evaluated for the service.\nError states preventing the evaluation from being performed will not update this timestamp.\n",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-15T07:20:50Z"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    }
  },
  "nullable": true,
  "required": [
    "is_passing",
    "evaluation_context",
    "evaluation_error",
    "successfully_evaluated_at",
    "attempted_at",
    "created_at"
  ]
}