Kong · Schema

StringConfigFieldSchema

Defines a string value integration config field.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
display_name	string	user-friendly name of the configuration field.
description	string	Optional brief description of the configuration field.
required	boolean	Denotes whether the config field is a required value.
mutable_condition	object
type	string	The field type of the config value.
default	string	The default value for the config field.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StringConfigFieldSchema",
  "title": "StringConfigFieldSchema",
  "description": "Defines a string value integration config field.",
  "type": "object",
  "properties": {
    "display_name": {
      "description": "user-friendly name of the configuration field.",
      "type": "string"
    },
    "description": {
      "description": "Optional brief description of the configuration field.",
      "type": "string"
    },
    "required": {
      "description": "Denotes whether the config field is a required value.",
      "type": "boolean",
      "default": false
    },
    "mutable_condition": {
      "$ref": "#/components/schemas/MutableCondition"
    },
    "type": {
      "description": "The field type of the config value.",
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "default": {
      "description": "The default value for the config field.",
      "type": "string"
    }
  },
  "required": [
    "type"
  ]
}