Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Request Transformer Advanced plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name
string requiredThe name of the plugin, in this case
request-transformer-advanced
. -
instance_name
stringAn optional custom name to identify an instance of the plugin, for example
request-transformer-advanced_my-service
. Useful when running the same plugin in multiple contexts, for example, on multiple services. -
service.name or service.id
stringThe name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level
/plugins
endpoint. Not required if using/services/SERVICE_NAME|ID/plugins
. -
route.name or route.id
stringThe name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level
/plugins
endpoint. Not required if using/routes/ROUTE_NAME|ID/plugins
. -
consumer.name or consumer.id
stringThe name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level
/plugins
endpoint. Not required if using/consumers/CONSUMER_NAME|ID/plugins
. -
consumer_group.name or consumer_group.id
stringThe name or ID of the consumer group the plugin targets. If set, the plugin will activate only for requests where the specified group has been authenticated
/plugins
endpoint. Not required if using/consumer_groups/{CONSUMER_GROUP_NAME|ID}/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
http_method
string matches:^%u+$
A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.
-
remove
record required-
body
array of typestring
-
headers
array of typestring
-
querystring
array of typestring
-
-
rename
record required-
body
array of typestring
referenceable
-
headers
array of typestring
referenceable
-
querystring
array of typestring
referenceable
-
-
replace
record required-
body
array of typestring
referenceable
-
headers
array of typestring
referenceable
-
querystring
array of typestring
referenceable
-
json_types
array of typestring
Must be one of:boolean
,number
,string
-
uri
string
-
-
add
record required-
body
array of typestring
referenceable
-
headers
array of typestring
referenceable
-
querystring
array of typestring
referenceable
-
json_types
array of typestring
Must be one of:boolean
,number
,string
-
-
append
record required-
body
array of typestring
referenceable
-
headers
array of typestring
referenceable
-
querystring
array of typestring
referenceable
-
json_types
array of typestring
Must be one of:boolean
,number
,string
-
-
allow
record required-
body
set of typestring
-
-
dots_in_keys
boolean default:true
Specify whether dots (for example,
customers.info.phone
) should be treated as part of a property name or used to descend into nested JSON objects. See Arrays and nested objects.
-