Kong · Schema

PatchGatewayRequest

The request schema for the patch gateway request.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	object
description	string	A human-readable description of the Gateway.
min_runtime_version	string	The minimum runtime version supported by the API. This is the lowest version of the data plane release that can be used with the entity model. When not specified, the minimum runtime version will not
labels	object	Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect",

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchGatewayRequest",
  "title": "PatchGatewayRequest",
  "description": "The request schema for the patch gateway request.",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/GatewayName"
    },
    "description": {
      "description": "A human-readable description of the Gateway.",
      "type": "string",
      "maxLength": 512,
      "nullable": true
    },
    "min_runtime_version": {
      "description": "The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will not be updated.\n",
      "type": "string",
      "example": "1.1",
      "nullable": true,
      "pattern": "^\\d+\\.\\d+$"
    },
    "labels": {
      "description": "Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",
      "type": "object",
      "example": {
        "env": "test"
      },
      "additionalProperties": {
        "type": "string",
        "pattern": "^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$",
        "minLength": 1,
        "maxLength": 63
      },
      "maxProperties": 50,
      "nullable": true,
      "title": "Labels"
    }
  },
  "additionalProperties": false
}