Kong · Schema
ResponseTransformerAdvancedPluginConfig
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 HTTP 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/ResponseTransformerAdvancedPluginConfig",
"title": "ResponseTransformerAdvancedPluginConfig",
"x-speakeasy-entity": "PluginResponseTransformerAdvanced",
"properties": {
"config": {
"type": "object",
"properties": {
"add": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json_types": {
"type": "array",
"items": {
"enum": [
"boolean",
"number",
"string"
],
"type": "string"
},
"default": []
}
}
},
"allow": {
"type": "object",
"properties": {
"json": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"append": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json_types": {
"type": "array",
"items": {
"enum": [
"boolean",
"number",
"string"
],
"type": "string"
},
"default": []
}
}
},
"dots_in_keys": {
"description": "Whether dots (for example, `customers.info.phone`) should be treated as part of a property name or used to descend into nested JSON objects..",
"type": "boolean",
"default": true
},
"remove": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"rename": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"replace": {
"type": "object",
"properties": {
"body": {
"description": "String with which to replace the entire response body.",
"type": "string"
},
"headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json_types": {
"type": "array",
"items": {
"enum": [
"boolean",
"number",
"string"
],
"type": "string"
},
"default": []
}
}
},
"transform": {
"type": "object",
"properties": {
"functions": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"if_status": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"json": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
}
}
},
"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": "response-transformer-advanced"
},
"protocols": {
"description": "A set of strings representing HTTP protocols.",
"type": "array",
"items": {
"enum": [
"grpc",
"grpcs",
"http",
"https"
],
"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"
}
}
}
}
}