Kong · Schema

CatalogIntegrationDiscovery

Defines how the integration participates in Discovery. Discovery enables integrations to automatically ingest and update resources in the catalog.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name Type Description
resource_integration_data_examples object A map of example resource `integration_data` payloads by resource type. - Keys are the machine-readable, globally unique names of resource types registered by this integration. - Values are example `i
View JSON Schema on GitHub

JSON Schema

kong-catalogintegrationdiscovery-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogIntegrationDiscovery",
  "title": "CatalogIntegrationDiscovery",
  "description": "Defines how the integration participates in Discovery.\nDiscovery enables integrations to automatically ingest and update resources in the catalog.\n",
  "type": "object",
  "properties": {
    "resource_integration_data_examples": {
      "description": "A map of example resource `integration_data` payloads by resource type.\n\n\n\n  - Keys are the machine-readable, globally unique names of resource types registered by this integration.\n  - Values are example `integration_data` payloads.\n",
      "type": "object",
      "example": {
        "gateway_service": {
          "control_plane": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "dev-ext",
            "labels": {
              "env": "development"
            }
          },
          "gateway_service": {
            "id": "11111111-1111-1111-1111-111111111111",
            "name": "gateway-service",
            "host": "konghq.com",
            "path": "/example",
            "type": "service",
            "port": 443,
            "protocol": "https",
            "enabled": true
          }
        }
      },
      "additionalProperties": {
        "type": "object",
        "additionalProperties": true,
        "description": "An example `integration_data` payload for the given resource type."
      }
    }
  },
  "nullable": true,
  "required": [
    "resource_integration_data_examples"
  ]
}