Kong · Schema

CatalogResource

Information about a catalog resource.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
name string The name of the resource. Will be `null` when the resource has not yet been hydrated by the integration.
integration object
type object
config object
integration_data object JSON object containing schemaless integration data of the resource. This field is always populated by the system backing the integration. When `null`, the resource has been manually initialized via AP
archived boolean Whether or not the resource has been archived.
service_associations number The number of catalog services this resource is mapped to.
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

kong-catalogresource-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogResource",
  "title": "CatalogResource",
  "description": "Information about a catalog resource.",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/CatalogResourceId"
    },
    "name": {
      "description": "The name of the resource.\nWill be `null` when the resource has not yet been hydrated by the integration.\n",
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "nullable": true
    },
    "integration": {
      "$ref": "#/components/schemas/IntegrationRef"
    },
    "type": {
      "$ref": "#/components/schemas/CatalogResourceType"
    },
    "config": {
      "$ref": "#/components/schemas/CatalogResourceConfig"
    },
    "integration_data": {
      "description": "JSON object containing schemaless integration data of the resource.\nThis field is always populated by the system backing the integration.\nWhen `null`, the resource has been manually initialized via API but has\nyet to be hydrated by the integration.\n",
      "type": "object",
      "additionalProperties": true,
      "nullable": true
    },
    "archived": {
      "description": "Whether or not the resource has been archived.",
      "type": "boolean",
      "example": false
    },
    "service_associations": {
      "description": "The number of catalog services this resource is mapped to.",
      "type": "number",
      "example": 2,
      "minimum": 0,
      "readOnly": true
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "required": [
    "id",
    "name",
    "integration",
    "type",
    "config",
    "integration_data",
    "archived",
    "service_associations",
    "created_at",
    "updated_at"
  ]
}