Kong · Schema

CatalogServiceRef

Short-hand descriptor of a catalog service.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name	Type	Description
id	string	The service ID.
name	string	The machine name of the service that uniquely identifies it within the catalog.
display_name	string	The display name of the service.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogServiceRef",
  "title": "CatalogServiceRef",
  "description": "Short-hand descriptor of a catalog service.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The service ID.",
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
    },
    "name": {
      "description": "The machine name of the service that uniquely identifies it within the catalog.\n",
      "type": "string",
      "example": "user-svc"
    },
    "display_name": {
      "description": "The display name of the service.",
      "type": "string",
      "example": "User Service"
    }
  },
  "required": [
    "id",
    "name",
    "display_name"
  ]
}