Skip to content

Commit

Permalink
Remove "byte" and "binary" formats altogether.
Browse files Browse the repository at this point in the history
Instead of just deprecating.  The "content*" keywords now
cover these use cases.
  • Loading branch information
handrews committed May 15, 2020
1 parent dcf9878 commit 7f49b70
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions versions/3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,6 @@ The formats defined by the OAS are:
`number` | `float` | |
`number` | `double` | |
`string` | `password` | A hint to UIs to obscure input.
`string` | `byte` | base64 encoded characters **Deprecated**
`string` | `binary` | any sequence of octets **Deprecated**

Use of `byte` or `binary` is discouraged, and later versions of this specification may remove them from this list. They SHOULD be replaced with the JSON Schema keywords `contentEncoding` or `contentMediaType` as follows:

* replace `"format": "byte"` with `"contentEncoding": "base64"` or `"contentEncoding": "base64url"`
* replace `"format": "binary"` with `"contentMediaType": "application/octet-stream"` or an appropriate specific media type

### <a name="richText"></a>Rich Text Formatting
Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting.
Expand Down Expand Up @@ -1550,7 +1543,6 @@ When passing in `multipart` types, boundaries MAY be used to separate sections o
* If the property is complex, or an array of complex values, the default Content-Type is `application/json`
* If the property is a `type: string` with a `contentMediaType`, the Content-Type is the value from `contentMediaType`
* If the property is a `type: string` with a `contentEncoding` of `base64` or `base64url`, but does _not_ have a `contentMediaType`, the default Content-Type is `application/octet-stream`
* **Deprecated:** If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream`


Examples:
Expand Down Expand Up @@ -1594,7 +1586,7 @@ A single encoding definition applied to a single schema property.
##### Fixed Fields
Field Name | Type | Description
---|:---:|---
<a name="encodingContentType"></a>contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with a `contentMediaType` - `contentMediaType`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types; **Deprecated:** for `string` with `format` being `binary` – `application/octet-stream`.
<a name="encodingContentType"></a>contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with a `contentMediaType` - `contentMediaType`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types.
<a name="encodingHeaders"></a>headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`.
<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 as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored.
<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`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored.
Expand Down

0 comments on commit 7f49b70

Please sign in to comment.