#Add or Set Query Parameters Policy

Adds or sets query parameters on the incoming request.

#Configuration

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

{
  "name": "my-set-query-params-inbound-policy",
  "policyType": "set-query-params-inbound",
  "handler": {
    "export": "SetQueryParamsInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "params": [
        {
          "name": "my-key",
          "value": "my-value"
        }
      ]
    }
  }
}

#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 set-query-params-inbound.
• handler.export <string> - The name of the exported type. Value should be SetQueryParamsInboundPolicy.
• 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) <object[]> - An array of query params to set in the request. By default, query parameters will be overwritten if they already exist in the request, specify the overwrite property to change this behavior.
  • name (required) <string> - The name of the param.
  • value (required) <string> - The value of the param.
  • overwrite <boolean> - Overwrite the value if the param is already present in the request. Defaults to true.

#Using the Policy

Read more about how policies work