You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.4.md
+6-3
Original file line number
Diff line number
Diff line change
@@ -2379,13 +2379,16 @@ When `example` or `examples` are provided in conjunction with the `schema` objec
2379
2379
2380
2380
Serializing with `schema` is NOT RECOMMENDED for headers with parameters (name=value pairs following a `;`) in their values, or where values might have non-URL-safe characters; see [Appendix D](#serializingHeadersAndCookies) for details.
2381
2381
2382
+
When `example` or `examples` are provided in conjunction with the `schema` object, the example SHOULD match the specified schema and follow the prescribed serialization strategy for the parameter.
2383
+
The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema.
2384
+
2382
2385
Field Name | Type | Description
2383
2386
---|:---:|---
2384
2387
<aname="headerStyle"></a>style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `simple`.
2385
-
<aname="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`.
2388
+
<aname="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.
2386
2389
<aname="headerSchema"></a>schema | [Schema Object](#schemaObject)\|[Reference Object](#referenceObject) | The schema defining the type used for the header.
2387
-
<aname="headerExample"></a>example | Any | Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
2388
-
<aname="headerExamples"></a>examples | Map[`string`, [Example Object](#exampleObject)\|[Reference Object](#referenceObject)] | Examples of the header's potential value. Each example SHOULD contain a value in the correct format as specified in the header encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema.
2390
+
<aname="headerExample"></a>example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples).
2391
+
<aname="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).
2389
2392
2390
2393
See also [Appendix C: Using RFC6570 Implementations](#usingRFC6570Implementations) for additional guidance.
0 commit comments