Kong · Schema
RequestTransformerPluginConfig
API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| config | object | |
| consumer | object | If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to acti |
| consumer_group | object | If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset |
| 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/RequestTransformerPluginConfig",
"title": "RequestTransformerPluginConfig",
"x-speakeasy-entity": "PluginRequestTransformer",
"properties": {
"config": {
"type": "object",
"properties": {
"add": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"querystring": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"append": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"querystring": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"http_method": {
"description": "A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.",
"type": "string"
},
"remove": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"querystring": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"rename": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"querystring": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"replace": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"querystring": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"uri": {
"type": "string"
}
}
}
}
},
"consumer": {
"description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"consumer_group": {
"description": "If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"name": {
"const": "request-transformer"
},
"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"
}
}
}
}
}