Kong · Schema

CreateCatalogService

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
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.
labels object
custom_fields object
View JSON Schema on GitHub

JSON Schema

kong-createcatalogservice-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateCatalogService",
  "title": "CreateCatalogService",
  "type": "object",
  "properties": {
    "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
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "custom_fields": {
      "$ref": "#/components/schemas/CustomFields"
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "display_name"
  ]
}