Response Transformer Advanced Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Response 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 required

  The name of the plugin, in this case response-transformer-advanced.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example response-transformer-advanced_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The 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

  string

  The 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

  string

  The 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

  string

  The 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
  • remove

    record required
    • json

      array of type string

    • headers

      array of type string

    • if_status

      array of type string

  • rename

    record required
    • headers

      array of type string

    • if_status

      array of type string

  • replace

    record required
    • body

      string

      String with which to replace the entire response body.

    • json

      array of type string

    • json_types

      array of type string Must be one of: boolean, number, string

    • headers

      array of type string

    • if_status

      array of type string

  • add

    record required
    • json

      array of type string

    • json_types

      array of type string Must be one of: boolean, number, string

    • headers

      array of type string

    • if_status

      array of type string

  • append

    record required
    • json

      array of type string

    • json_types

      array of type string Must be one of: boolean, number, string

    • headers

      array of type string

    • if_status

      array of type string

  • allow

    record required
    • json

      set of type string

  • transform

    record required
    • functions

      array of type string

    • if_status

      array of type string

    • json

      array of type string

  • dots_in_keys

    boolean default: true

    Whether dots (for example, customers.info.phone) should be treated as part of a property name or used to descend into nested JSON objects..