[I] PathParameterOptions
Path parameter options with all defaults resolved: simple style, no expansion, and reserved characters encoded unless overridden by the decorator or URI template.
Extends
Section titled “Extends”Required<PathOptions>
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
allowReserved | readonly | boolean | When interpolating this parameter do not encode reserved characters. Equivalent of adding + in the path parameter as per RFC-6570 | Required.allowReserved |
explode | readonly | boolean | When interpolating this parameter in the case of array or object expand each value using the given style. Equivalent of adding * in the path parameter as per RFC-6570 | Required.explode |
name | readonly | string | Name of the parameter in the URI template. | Required.name |
style | readonly | "simple" | "label" | "matrix" | "fragment" | "path" | Different interpolating styles for the path parameter. - simple: No special encoding. - label: Using . separator. - matrix: ; as separator. - fragment: # as separator. - path: / as separator. | Required.style |
type | public | "path" | Identifies a value interpolated into the URI path. | - |