Kong · Schema

CustomFields

Map of customizable, catalog-defined fields providing information about a service.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source
View JSON Schema on GitHub

JSON Schema

kong-customfields-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomFields",
  "title": "CustomFields",
  "description": "Map of customizable, catalog-defined fields providing information about a service.\n",
  "type": "object",
  "example": {
    "owner": "John Appleseed",
    "dashboard": {
      "name": "On-Call Dashboard",
      "link": "https://my-dashboard-svc.io/dashboards/1"
    }
  },
  "additionalProperties": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/TextCustomField"
      },
      {
        "$ref": "#/components/schemas/NumericCustomField"
      },
      {
        "$ref": "#/components/schemas/BooleanCustomField"
      },
      {
        "$ref": "#/components/schemas/UrlCustomField"
      }
    ]
  },
  "x-speakeasy-type-override": "any"
}