Skip to content

Commit cd37500

Browse files
committed
Removed Encoding Object
Renamed Encoding Property Object to Encoding Object.
1 parent dd6eb33 commit cd37500

File tree

1 file changed

+11
-20
lines changed

1 file changed

+11
-20
lines changed

versions/3.0.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ Additional utilities can also take advantage of the resulting files, such as tes
4646
- [Content Object](#contentObject)
4747
- [Media Type Object](#mediaTypeObject)
4848
- [Encoding Object](#encodingObject)
49-
- [Encoding Property Object](#encodingPropertyObject)
5049
- [Responses Object](#responsesObject)
5150
- [Response Object](#responseObject)
5251
- [Callbacks Object](#callbacksObject)
@@ -1326,7 +1325,7 @@ Field Name | Type | Description
13261325
<a name="mediaTypeSchema"></a>schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | The schema defining the type used for the request body.
13271326
<a name="mediaTypeExample"></a>example | Any | Example of the media type. The example object SHOULD be in the correct format as specified in the media type. The `example` object is mutually exclusive to the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the the example provided by the schema.
13281327
<a name="mediaTypeExamples"></a>examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema.
1329-
<a name="mediaTypeEncoding"></a>encoding | [Encoding Object](#encodingObject) | Encoding of the media type. The encoding object SHOULD only apply to `requestBody` objects when the content type is `multipart`.
1328+
<a name="mediaTypeEncoding"></a>encoding | Map[`string`, [Encoding Object](#encodingObject)] | A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHOULD only apply to `requestBody` objects when the content type is `multipart`.
13301329

13311330
This object can be extended with [Specification Extensions](#specificationExtensions).
13321331

@@ -1510,12 +1509,18 @@ In scenarios where more control is needed over the Content-Type for `multipart`
15101509

15111510
#### <a name="encodingObject"></a>Encoding Object
15121511

1513-
An object representing multipart region encoding for `requestBody` objects.
1512+
A single encoding definition applied to a single schema property.
15141513

1515-
##### Patterned Fields
1516-
Field Pattern | Type | Description
1514+
##### Fixed Fields
1515+
Field Name | Type | Description
15171516
---|:---:|---
1518-
<a name="encodingProperty"></a>{property} | [Encoding Property Object](#encodingPropertyObject) | The property name to which the special encoding are applied. This field MUST exist in the schema as a property.
1517+
<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.
1518+
<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.
1519+
<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.
1520+
<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`.
1521+
<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`.
1522+
1523+
This object can be extended with [Specification Extensions](#specificationExtensions).
15191524

15201525
##### Encoding Object Example
15211526

@@ -1552,20 +1557,6 @@ requestBody:
15521557
contentType: image/png, image/jpeg
15531558
```
15541559

1555-
#### <a name="encodingPropertyObject"></a>Encoding Property Object
1556-
1557-
A single encoding definition applied to a single schema property.
1558-
1559-
##### Fixed Fields
1560-
Field Name | Type | Description
1561-
---|:---:|---
1562-
<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.
1563-
<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.
1564-
<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.
1565-
<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`.
1566-
<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`.
1567-
1568-
This object can be extended with [Specification Extensions](#specificationExtensions).
15691560

15701561
#### <a name="responsesObject"></a>Responses Object
15711562

0 commit comments

Comments
 (0)