Kong · Schema

API Attribute List Item

Entities that describe APIs

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
created_at object
updated_at object
key string A unique key that can contain lowercase letters, numbers, hyphens, and underscores
values array
View JSON Schema on GitHub

JSON Schema

kong-apiattributelistitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiAttributeListItem",
  "title": "API Attribute List Item",
  "description": "Entities that describe APIs",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "key": {
      "description": "A unique key that can contain lowercase letters, numbers, hyphens, and underscores",
      "type": "string",
      "format": "^[a-z0-9-_]{0,128}$",
      "example": "kind",
      "maxLength": 128
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "value",
          "api_count"
        ],
        "properties": {
          "value": {
            "description": "A keyword describing the API under the attribute key",
            "type": "string",
            "example": "REST",
            "maxLength": 512,
            "minLength": 1,
            "pattern": "^[^,<>]*$"
          },
          "api_count": {
            "type": "integer"
          }
        }
      }
    }
  },
  "additionalProperties": false,
  "readOnly": true,
  "required": [
    "id",
    "key",
    "values",
    "created_at",
    "updated_at"
  ]
}