Kong · Schema

API Operation

An operation linked to an API

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string The API operation identifier.
method object
path string The path of the operation.
implementation_status object
View JSON Schema on GitHub

JSON Schema

kong-apioperation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiOperation",
  "title": "API Operation",
  "description": "An operation linked to an API",
  "type": "object",
  "properties": {
    "id": {
      "description": "The API operation identifier.",
      "type": "string",
      "format": "uuid",
      "example": "b42d905a-ed33-46a3-a093-d8f536af9a8a",
      "readOnly": true
    },
    "method": {
      "$ref": "#/components/schemas/Method"
    },
    "path": {
      "description": "The path of the operation.",
      "type": "string",
      "example": "/users/*"
    },
    "implementation_status": {
      "$ref": "#/components/schemas/ApiOperationImplementationStatus"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "method",
    "path"
  ]
}