PathParameterWithOptions interface

An object that can be passed as a path parameter, allowing for additional options to be set relating to how the parameter is encoded.

Properties

allowReserved

Whether to allow for reserved characters in the value. If set to true, special characters such as '/' in the parameter's value will not be URL encoded. Defaults to false.

value

The value of the parameter.

Property Details

allowReserved

Whether to allow for reserved characters in the value. If set to true, special characters such as '/' in the parameter's value will not be URL encoded. Defaults to false.

allowReserved?: boolean

Property Value

boolean

value

The value of the parameter.

value: string | number

Property Value

string | number