You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.md
+12-13Lines changed: 12 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
42
42
- [Parameter Object](#parameterObject)
43
43
- [Request Body Object](#requestBodyObject)
44
44
- [Content Object](#contentObject)
45
-
- [Content Type Object](#contentTypeObject)
45
+
- [Media Type Object](#mediaTypeObject)
46
46
- [Responses Object](#responsesObject)
47
47
- [Response Object](#responseObject)
48
48
- [Headers Object](#headersObject)
@@ -759,8 +759,8 @@ Field Name | Type | Description
759
759
<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`.
760
760
<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`.
761
761
<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.
764
764
765
765
For more complex scenarios a `content` object can be used to define the media-type
766
766
and schema of the parameter. This option is mutually exclusive with the simple scenario
@@ -1023,10 +1023,10 @@ content:
1023
1023
1024
1024
#### <a name="contentObject"></a>Content Object
1025
1025
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),
1027
1027
[parameter objects](#parameterObject), [header objects](#headerObject), and [response objects](#responseObject).
1028
1028
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).
1030
1030
1031
1031
##### Content Examples
1032
1032
@@ -1081,25 +1081,24 @@ content:
1081
1081
- "Bob,Diane,Mary,Bill"
1082
1082
```
1083
1083
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).
1086
1086
1087
1087
##### Fixed Fields
1088
1088
Field Name | Type | Description
1089
1089
---|:---:|---
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`.
1094
1094
1095
1095
##### Patterned Fields
1096
1096
Field Pattern | Type | Description
1097
1097
---|:---:|---
1098
1098
<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.
0 commit comments