Skip to content

Commit 9886038

Browse files
committed
Rename Content Type Object to Media Type Object
1 parent 1425dba commit 9886038

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

versions/3.0.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
4242
- [Parameter Object](#parameterObject)
4343
- [Request Body Object](#requestBodyObject)
4444
- [Content Object](#contentObject)
45-
- [Content Type Object](#contentTypeObject)
45+
- [Media Type Object](#mediaTypeObject)
4646
- [Responses Object](#responsesObject)
4747
- [Response Object](#responseObject)
4848
- [Headers Object](#headersObject)
@@ -759,8 +759,8 @@ Field Name | Type | Description
759759
<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter 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 parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`.
760760
<a name="parameterAllowReserved"></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. This property only applies to parameters with an `in` value of `query`. The default value is `false`.
761761
<a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
762-
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject)] | Examples of the content type. Each example in the Examples array SHOULD be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema.
763-
<a name="parameterExample"></a>example | [Example Object](#exampleObject) | Example of the content type. The example object SHOULD be in the correct format as specified in the parameter encoding. 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 example provided by the the schema.
762+
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject)] | Examples of the media type. Each example in the Examples array SHOULD be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema.
763+
<a name="parameterExample"></a>example | [Example Object](#exampleObject) | Example of the media type. The example object SHOULD be in the correct format as specified in the parameter encoding. 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 example provided by the the schema.
764764

765765
For more complex scenarios a `content` object can be used to define the media-type
766766
and schema of the parameter. This option is mutually exclusive with the simple scenario
@@ -1023,10 +1023,10 @@ content:
10231023

10241024
#### <a name="contentObject"></a>Content Object
10251025

1026-
Describes a set of supported content types. A content object can be used in [requestBody](#requestBody),
1026+
Describes a set of supported media types. A content object can be used in [requestBody](#requestBody),
10271027
[parameter objects](#parameterObject), [header objects](#headerObject), and [response objects](#responseObject).
10281028

1029-
Each key in the content object is the media-type of the [Content Type Object](#contentTypeObject).
1029+
Each key in the content object is the media-type of the [Media Type Object](#mediaTypeObject).
10301030

10311031
##### Content Examples
10321032

@@ -1081,25 +1081,24 @@ content:
10811081
- "Bob,Diane,Mary,Bill"
10821082
```
10831083

1084-
#### <a name="contentTypeObject"></a>Content Type Object
1085-
Each content type object provides schema and examples for a the media type identified by its key. Content Type objects can be used in a [content object](#contentObject).
1084+
#### <a name="mediaTypeObject"></a>Media Type Object
1085+
Each media type object provides schema and examples for a the media type identified by its key. Media Type objects can be used in a [content object](#contentObject).
10861086

10871087
##### Fixed Fields
10881088
Field Name | Type | Description
10891089
---|:---:|---
1090-
<a name="contentTypeSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
1091-
<a name="contentTypeExamples"></a>examples | [Examples Array](#examplesArray) | Examples of the content type. Each example in the Examples array SHOULD be in the correct format as specified in the _content_ type. 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.
1092-
<a name="contentTypeExample"></a>example | [Example Object](#exampleObject) | Example of the content type. The example object SHOULD be in the correct format as specified in the _content_ 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.
1093-
<a name="contentTypeEncoding"></a>encoding | [Encoding Object](#encodingObject) | Encoding of the content type. The encoding object SHOULD only apply to `requestBody` objects when the content type is `multipart`.
1090+
<a name="mediaTypeSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
1091+
<a name="mediaTypeExamples"></a>examples | [Examples Array](#examplesArray) | Examples of the media type. Each example in the Examples array SHOULD be in the correct format as specified in the _content_ type. 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.
1092+
<a name="mediaTypeExample"></a>example | [Example Object](#exampleObject) | Example of the media type. The example object SHOULD be in the correct format as specified in the _content_ 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.
1093+
<a name="mediaTypeEncoding"></a>encoding | [Encoding Object](#encodingObject) | Encoding of the media type. The encoding object SHOULD only apply to `requestBody` objects when the media type is `multipart`.
10941094

10951095
##### Patterned Fields
10961096
Field Pattern | Type | Description
10971097
---|:---:|---
10981098
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Specification Extensions](#specificationExtensions) for further details.
10991099

1100-
##### Content Type Examples
1100+
##### Media Type Examples
11011101

1102-
A content type description.
11031102
```js
11041103
{
11051104
"application/json": {

0 commit comments

Comments
 (0)