Skip to content

Commit

Permalink
No need to mention deepObject for Header
Browse files Browse the repository at this point in the history
That style is not usable for the Header Object anyway.
  • Loading branch information
handrews committed Jun 12, 2024
1 parent ce87bf2 commit 17e3eed
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion versions/3.0.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -2470,7 +2470,7 @@ The `example` and `examples` fields are mutually exclusive, and if either is pre
Field Name | Type | Description
---|:---:|---
<a name="headerStyle"></a>style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `simple`.
<a name="headerExplode"></a>explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this property has no effect. The default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined.
<a name="headerExplode"></a>explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this property has no effect. The default value is `false`.
<a name="headerSchema"></a>schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | The schema defining the type used for the header.
<a name="headerExample"></a>example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples).
<a name="headerExamples"></a>examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples).
Expand Down

0 comments on commit 17e3eed

Please sign in to comment.