Skip to content

Commit 2c2af48

Browse files
committed
added example, type clarification for encoding headers
1 parent 43ca992 commit 2c2af48

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

versions/3.0.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1561,6 +1561,8 @@ requestBody:
15611561
profileImage:
15621562
# only accept png/jpeg
15631563
contentType: image/png, image/jpeg
1564+
headers:
1565+
x-source: profile
15641566
```
15651567

15661568
#### <a name="encodingPropertyObject"></a>Encoding Property Object
@@ -1571,7 +1573,7 @@ A single encoding definition applied to a single schema property.
15711573
Field Name | Type | Description
15721574
---|:---:|---
15731575
<a name="encodingContentType"></a>contentType | `string` | The Content-Type to use for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type.
1574-
<a name="encodingHeaders"></a>headers | `object` | A string map allowing additional information to be provided as headers, for example `Content-Disposition`. Note `Content-Type` is described separately and will be ignored from this section.
1576+
<a name="encodingHeaders"></a>headers | `map[String, String]` | A string map allowing additional information to be provided as headers, for example `Content-Disposition`. Note `Content-Type` is described separately and will be ignored from this section.
15751577
<a name="encodingStyle"></a>style | `string` | Describes how a specific property value will be serialized depending on its type . See [Parameter Object](#parameterObject) for details on the [`style`](#parameterStyle) property. The behavior follows the same values allowed for `query` parameters, including default values.
15761578
<a name="encodingExplode"></a>explode | `boolean` | When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`.
15771579
<a name="encodingAllowReserved"></a>allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`.

0 commit comments

Comments
 (0)