Kong · Schema
PreFunctionPluginConfig
API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| config | object | |
| name | object | |
| protocols | array | A set of strings representing protocols. |
| route | object | If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used. |
| service | object | If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PreFunctionPluginConfig",
"title": "PreFunctionPluginConfig",
"x-speakeasy-entity": "PluginPreFunction",
"properties": {
"config": {
"type": "object",
"properties": {
"access": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"body_filter": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"certificate": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"header_filter": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"log": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"rewrite": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ws_client_frame": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ws_close": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ws_handshake": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ws_upstream_frame": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"name": {
"const": "pre-function"
},
"protocols": {
"description": "A set of strings representing protocols.",
"type": "array",
"items": {
"description": "A string representing a protocol, such as HTTP or HTTPS.",
"enum": [
"grpc",
"grpcs",
"http",
"https",
"tcp",
"tls",
"tls_passthrough",
"udp",
"ws",
"wss"
],
"type": "string"
},
"format": "set",
"default": [
"grpc",
"grpcs",
"http",
"https"
]
},
"route": {
"description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"service": {
"description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
}
}