Request Modification

Remove Query Parameters Policy

Remove query parameters from the incoming request

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.


config/policies.json
{
  "name": "my-remove-query-params-inbound-policy",
  "policyType": "remove-query-params-inbound",
  "handler": {
    "export": "RemoveQueryParamsInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "params": ["param1", "param2"]
    }
  }
}

Policy Configuration

name <string> - The name of your policy instance. This is used as a reference in your routes.
policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be remove-query-params-inbound.
handler.export <string> - The name of the exported type. Value should be RemoveQueryParamsInboundPolicy.
handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

params (required) <string[]> - An array of query parameters to be removed from the incoming request.

Using the Policy