Skip to content

Commit 92b8028

Browse files
committed
Merged Marsh's content-type changes in this PR
1 parent e2fcaeb commit 92b8028

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

versions/3.0.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,7 @@ Field Name | Type | Description
933933
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject) <span>&#124;</span> [Reference Object](#referenceObject)] | 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` which contains an example, the `examples` value SHALL _override_ the example provided by the schema.
934934
<a name="parameterExample"></a>example | [Example Object](#exampleObject) <span>&#124;</span> [Reference Object](#referenceObject) | 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.
935935

936-
For more complex scenarios a `content` object can be used to define the media-type
936+
For more complex scenarios a [Content Object](#contentObject) can be used to define the media type
937937
and schema of the parameter. This option is mutually exclusive with the simple scenario
938938
above. When `example` or `examples` are provided in conjunction with the `schema` object,
939939
the example must follow the prescribed serialization strategy for the parameter.
@@ -1453,7 +1453,7 @@ requestBody:
14531453
format: binary
14541454
encoding:
14551455
historyMetadata:
1456-
# require XML content-type in utf-8 encoding
1456+
# require XML Content-Type in utf-8 encoding
14571457
contentType: application/xml; charset=utf-8
14581458
profileImage:
14591459
# only accept png/jpeg
@@ -1467,9 +1467,9 @@ A single encoding definition applied to a single schema property.
14671467
##### Fixed Fields
14681468
Field Name | Type | Description
14691469
---|:---:|---
1470-
<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 - `plain/text`; for `object` - `application/json`; for `array` - the default is defined based on the inner type.
1470+
<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 - `plain/text`; for `object` - `application/json`; for `array` - the default is defined based on the inner type.
14711471
<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.
1472-
<a name="encodingStyle"></a>style | `string` | The content-type to use for encoding a specific property. See (#parameterContent) for details on the [`style`](#parameterStyle) property. The behavior follows the same values allowed for `query` parameters, including default values.
1472+
<a name="encodingStyle"></a>style | `string` | The Content-Type to use for encoding a specific property. See (#parameterContent) for details on the [`style`](#parameterStyle) property. The behavior follows the same values allowed for `query` parameters, including default values.
14731473
<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`.
14741474

14751475
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -1890,7 +1890,7 @@ Because of the potential for name clashes, consider the `href` syntax as the pre
18901890

18911891
#### <a name="responsePayload"></a>Response Payload Values
18921892

1893-
Payload values are only available in parsable response payloads which match the advertised media-type and for media-types that can be referenced using a JSON Pointer fragment Id.
1893+
Payload values are only available in parsable response payloads which match the advertised media type and for media types that can be referenced using a JSON Pointer fragment Id.
18941894
In all cases, if a value does _not_ exist, the parameter will be considered a `null` value (as opposed to an empty value) and _not_ passed as a parameter to the linked resource.
18951895
In cases where a value is required, and a parameter is not supplied, the client MAY choose to not follow the link definition.
18961896

@@ -2255,7 +2255,7 @@ components:
22552255

22562256

22572257
### <a name="linkParametersObject"></a>Link Parameters Object
2258-
Using the `operationId` to reference an operation in the definition has many benefits, including the ability to define media-type options, security requirements, response and error payloads.
2258+
Using the `operationId` to reference an operation in the definition has many benefits, including the ability to define media type options, security requirements, response and error payloads.
22592259
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
22602260

22612261
To specify parameters required by the operation, we can use a **Link Parameters Object**.
@@ -2364,7 +2364,7 @@ definitions:
23642364
example:
23652365
$ref: http://foo.bar#/examples/name-example
23662366
2367-
# in a request body, note the plural `examples` as the content-type is set to `*`:
2367+
# in a request body, note the plural `examples` as the Content-Type is set to `*`:
23682368
requestBody:
23692369
content:
23702370
'application/json':

0 commit comments

Comments
 (0)