[I] HeaderFieldOptions
Wire name and serialization options for a header property.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
explode? | boolean | Equivalent of adding * in the path parameter as per RFC-6570 | Style | Explode | Primitive value = 5 | Array = [3, 4, 5] | Object = {“role”: “admin”, “firstName”: “Alex”} | | ------ | ------- | ------------------- | ----------------- | ----------------------------------------------- | | simple | false | id=5 | 3,4,5 | role,admin,firstName,Alex | | simple | true | id=5 | 3,4,5 | role=admin,firstName=Alex | |
name | string | HTTP header name, which may differ from the TypeSpec property name. |
type | "header" | Identifies header metadata rather than another parameter location. |