x-allowReserved extension

Respect supports the x-allowReserved extension on step parameters in Arazzo descriptions. Use it when a step passes a query parameter whose value must keep RFC 3986 reserved characters unencoded in the request URL.

Use x-allowReserved when:

• A query parameter value contains reserved characters: : / ? # [ ] @ ! $ & ' ( ) * + , ; =.
• You need the query string value sent "as-is". For example, the value is a full URL or a value that already uses reserved characters.
• Without x-allowReserved, Respect encodes reseved characters (for example, : → %3A).

This matches the OpenAPI 3.x Parameter.allowReserved behavior. When a step uses an OpenAPI operation, Respect also honors allowReserved from the operation's parameters. For step parameters you define in the Arazzo description, use the x-allowReserved extension.

workflows:
  - workflowId: example
    steps:
      - stepId: get-with-filter
        operationId: my-api.getSearch
        parameters:
          - in: query
            name: filter
            value: "https://example.com/path/to;x,y(z)a*b.c[1]@v"
            x-allowReserved: true
        successCriteria:
          - condition: $statusCode == 200

With x-allowReserved: true, the query string is sent as:

?filter=https://example.com/path/to;x,y(z)a*b.c[1]@v

Reserved characters in the value are left unencoded.

• Respect commands
• OpenAPI 3 Parameter object (allowReserved)