Kong · Schema

CatalogIntegrationResourceTypes

Defines the resource types that the integration manages within the catalog. This schema is a key-value object where: - Keys are globally unique, machine-readable identifiers for each resource type. - Values are objects describing metadata about the resource type. This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration. By registering resource types, integrations communicate the kinds of entities they will ingest and maintain, allowing the catalog to enforce consistency, validation, and visibility across all integrations.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogIntegrationResourceTypes",
  "title": "CatalogIntegrationResourceTypes",
  "description": "Defines the resource types that the integration manages within the catalog.\n\nThis schema is a key-value object where:\n\n\n  - Keys are globally unique, machine-readable identifiers for each resource type.\n  - Values are objects describing metadata about the resource type.\n\nThis declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.\nBy registering resource types, integrations communicate the kinds of entities they will ingest and maintain,\nallowing the catalog to enforce consistency, validation, and visibility across all integrations.\n",
  "type": "object",
  "example": {
    "gateway_svc": {
      "display_name": "Gateway Service",
      "schema": {
        "type": "simple",
        "definition": {
          "control_plane_id": "string",
          "gatway_service_id": "string"
        }
      }
    },
    "analytics_dashboard": {
      "display_name": "Dashboard",
      "schema": {
        "type": "simple",
        "definition": {
          "dashboard_id": "string"
        }
      }
    }
  },
  "additionalProperties": {
    "type": "object",
    "title": "ResourceType",
    "required": [
      "schema"
    ],
    "properties": {
      "display_name": {
        "description": "The user-friendly resource type name.",
        "type": "string"
      },
      "schema": {
        "$ref": "#/components/schemas/SimpleSchema"
      }
    }
  }
}