Kong · Schema

CatalogIntegration

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	string	The machine name of the integration that uniquely identifies it within the catalog.
display_name	string	The display name of the integration.
description	string	The description of the integration.
built_in	boolean	Denotes whether the integration is built-in to the catalog. Built-in integrations are always connected and available by default.
version	string	The integration version.
visibility	string	The visibility of the integration.
authorization	object
config_schema	object
resource_types	object
discovery	object
api_spec_provider	object
events	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogIntegration",
  "title": "CatalogIntegration",
  "type": "object",
  "properties": {
    "name": {
      "description": "The machine name of the integration that uniquely identifies it within the catalog.",
      "type": "string",
      "example": "gateway-manager",
      "readOnly": true
    },
    "display_name": {
      "description": "The display name of the integration.",
      "type": "string",
      "example": "Gateway Manager"
    },
    "description": {
      "description": "The description of the integration.",
      "type": "string"
    },
    "built_in": {
      "description": "Denotes whether the integration is built-in to the catalog.\nBuilt-in integrations are always connected and available by default.\n",
      "type": "boolean",
      "example": true,
      "readOnly": true
    },
    "version": {
      "description": "The integration version.",
      "type": "string",
      "example": "v1",
      "readOnly": true
    },
    "visibility": {
      "description": "The visibility of the integration.",
      "type": "string",
      "example": "public",
      "enum": [
        "public",
        "private"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "authorization": {
      "$ref": "#/components/schemas/CatalogIntegrationAuthorization"
    },
    "config_schema": {
      "$ref": "#/components/schemas/CatalogIntegrationConfigSchema"
    },
    "resource_types": {
      "$ref": "#/components/schemas/CatalogIntegrationResourceTypes"
    },
    "discovery": {
      "$ref": "#/components/schemas/CatalogIntegrationDiscovery"
    },
    "api_spec_provider": {
      "$ref": "#/components/schemas/CatalogIntegrationApiSpecProvider"
    },
    "events": {
      "$ref": "#/components/schemas/CatalogIntegrationEvents"
    }
  },
  "required": [
    "built_in",
    "name",
    "display_name",
    "version",
    "authorization",
    "config_schema",
    "resource_types",
    "discovery",
    "api_spec_provider",
    "events",
    "visibility"
  ]
}