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
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -933,7 +933,7 @@ Field Name | Type | Description
933
933
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject) <span>|</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.
934
934
<a name="parameterExample"></a>example | [Example Object](#exampleObject) <span>|</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.
935
935
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 mediatype
937
937
and schema of the parameter. This option is mutually exclusive with the simple scenario
938
938
above. When `example` or `examples` are provided in conjunction with the `schema` object,
939
939
the example must follow the prescribed serialization strategy for the parameter.
@@ -1453,7 +1453,7 @@ requestBody:
1453
1453
format: binary
1454
1454
encoding:
1455
1455
historyMetadata:
1456
-
# require XML content-type in utf-8 encoding
1456
+
# require XML Content-Type in utf-8 encoding
1457
1457
contentType: application/xml; charset=utf-8
1458
1458
profileImage:
1459
1459
# only accept png/jpeg
@@ -1467,9 +1467,9 @@ A single encoding definition applied to a single schema property.
1467
1467
##### Fixed Fields
1468
1468
Field Name | Type | Description
1469
1469
---|:---:|---
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.
1471
1471
<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.
1473
1473
<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`.
1474
1474
1475
1475
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
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 mediatype and for mediatypes that can be referenced using a JSON Pointer fragment Id.
1894
1894
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.
1895
1895
In cases where a value is required, and a parameter is not supplied, the client MAY choose to not follow the link definition.
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 mediatype options, security requirements, response and error payloads.
2259
2259
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
2260
2260
2261
2261
To specify parameters required by the operation, we can use a **Link Parameters Object**.
@@ -2364,7 +2364,7 @@ definitions:
2364
2364
example:
2365
2365
$ref: http://foo.bar#/examples/name-example
2366
2366
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 `*`:
0 commit comments