Merge pull request OAI#1102 from OAI/issue-987

added example, type clarification for encoding headers

Author: RobDolinMS

versions/3.0.md

@@ -1561,6 +1561,10 @@ requestBody:
         profileImage:
           # only accept png/jpeg
           contentType: image/png, image/jpeg
+          headers:
+            X-Rate-Limit-Limit:
+            description: The number of allowed requests in the current period
+            type: integer
 ```
 
 #### <a name="encodingPropertyObject"></a>Encoding Property Object
@@ -1571,7 +1575,7 @@ A single encoding definition applied to a single schema property.
 Field Name | Type | Description
 ---|:---:|---
 <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.
-<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.
+<a name="encodingHeaders"></a>headers | Map[`string`, 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.
 <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.
 <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`.
 <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`.