Kong · Schema

API Package Operation Response

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The API Operation identifier.
api	object
method	object
path	string	The path of the API Operation.
rate_limiting_config	object	Rate limit configuration that can be applied to an API Package or an API Package Operation.
created_at	object
updated_at	object
implementation_status	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiPackageOperationResponseSchema",
  "title": "API Package Operation Response",
  "type": "object",
  "properties": {
    "id": {
      "description": "The API Operation identifier.",
      "type": "string",
      "format": "uuid",
      "example": "0f5061ce-78f6-4452-9108-ad7c02821fd6",
      "readOnly": true
    },
    "api": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "The API identifier.",
          "type": "string",
          "format": "uuid",
          "example": "0f5061ce-78f6-4452-9108-ad7c02821fd6",
          "readOnly": true
        },
        "name": {
          "description": "The name of the API this operation belongs to.",
          "type": "string",
          "example": "MyAPI",
          "readOnly": true
        },
        "version": {
          "description": "The version of the API this operation belongs to.",
          "type": "string",
          "example": "1.0.0",
          "readOnly": true
        }
      },
      "readOnly": true,
      "required": [
        "id",
        "name",
        "version"
      ]
    },
    "method": {
      "$ref": "#/components/schemas/Method"
    },
    "path": {
      "description": "The path of the API Operation.",
      "type": "string",
      "example": "/users/{user_id}",
      "readOnly": true
    },
    "rate_limiting_config": {
      "description": "Rate limit configuration that can be applied to an API Package or an API Package Operation.",
      "type": "object",
      "additionalProperties": false,
      "nullable": true,
      "properties": {
        "limit": {
          "description": "The amount of requests allowed for each operation within the specified duration.",
          "type": "integer",
          "minimum": 0
        },
        "duration": {
          "description": "The timeframe to ensure that an application does not exceed the request limit.",
          "type": "string",
          "enum": [
            "seconds",
            "minutes",
            "hours"
          ],
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "readOnly": true,
      "required": [
        "limit",
        "duration"
      ],
      "title": "Rate Limiting configuration"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "implementation_status": {
      "$ref": "#/components/schemas/ApiOperationImplementationStatus"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "api",
    "method",
    "path",
    "created_at",
    "updated_at",
    "rate_limiting_config"
  ]
}