Kong · Schema

CatalogService

The service object contains information about a Service 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.
description	string	Optionally provide a description of the Service.
custom_fields	object
labels	object
created_at	object
updated_at	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogService",
  "title": "CatalogService",
  "description": "The service object contains information about a Service Catalog service.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The service ID.",
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "readOnly": true
    },
    "name": {
      "description": "The machine name of the Service that uniquely identifies it within the catalog.\n",
      "type": "string",
      "example": "user-svc",
      "maxLength": 120,
      "minLength": 1,
      "pattern": "^[0-9a-z.-]+$"
    },
    "display_name": {
      "description": "The display name of the Service.",
      "type": "string",
      "example": "User Service",
      "maxLength": 120,
      "minLength": 1
    },
    "description": {
      "description": "Optionally provide a description of the Service.",
      "type": "string",
      "maxLength": 2048,
      "nullable": true
    },
    "custom_fields": {
      "$ref": "#/components/schemas/CustomFields"
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "required": [
    "id",
    "name",
    "display_name",
    "description",
    "custom_fields",
    "labels",
    "created_at",
    "updated_at"
  ]
}