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
+6-13Lines changed: 6 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -527,7 +527,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
527
527
"items": {
528
528
"type": "string"
529
529
},
530
-
"style": "comma-delimited"
530
+
"style": "commaDelimited"
531
531
}
532
532
]
533
533
}
@@ -578,7 +578,7 @@ Field Name | Type | Description
578
578
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
579
579
<a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
580
580
<a name="operationParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>|</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's parameters](#oasParameters).
581
-
<a name="operationRequestBody"></a>requestBody | [[Request Body Object](#requestBodyObject) <span>|</span> [Reference Object](#referenceObject)] | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the [HTTP 1.1 specification](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies.
581
+
<a name="operationRequestBody"></a>requestBody | [[Request Body Object](#requestBodyObject) <span>|</span> [Reference Object](#referenceObject)] | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the [HTTP 1.1 specification](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` shall be ignored by consumers.
582
582
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
583
583
<a name="operationCallbacks"></a>callback responses | [Callback Responses Object](#callbackObject) | The list of possible callback responses as they are returned from executing this operation.
584
584
<a name="operationDeprecated"></a>deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`.
@@ -1115,18 +1115,10 @@ schema:
1115
1115
schema:
1116
1116
type: string
1117
1117
format: binary
1118
-
1119
-
# multiple files:
1120
-
schema:
1121
-
type: array
1122
-
items:
1123
-
type: string
1124
-
format: binary
1125
1118
```
1126
1119
1127
1120
Note that the above examples apply to either input payloads (i.e. file uploads) or response payloads.
1128
1121
1129
-
1130
1122
A `requestBody` example for submitting a file in a `POST` operation therefore may look like the following:
1131
1123
1132
1124
```yaml
@@ -1230,9 +1222,7 @@ An object representing multipart region encoding for `requestBody` objects
1230
1222
##### Patterned Fields
1231
1223
Field Pattern | Type | Description
1232
1224
---|:---:|---
1233
-
<a name="encodingObjectProperty"></a>The property to apply encoding to | [Encoding Property](#encodingProperty) <span>|</span> [Encoding](#encoding) | The field name to apply special encoding attributes to. This field must exist in the schema as a property. To avoid collisions with specification extensions, properties may not begin with `x-`.
1234
-
1235
-
This object can be extended with [Specification Extensions](#specificationExtensions).
1225
+
<a name="encodingObjectProperty"></a>The property to apply encoding to | [Encoding Property](#encodingProperty) <span>|</span> [Encoding](#encoding) | The field name to apply special encoding attributes to. This field must exist in the schema as a property.
1236
1226
1237
1227
#### <a name="encoding"></a>Encoding
1238
1228
@@ -1242,6 +1232,9 @@ A single encoding definition applied to a single schema property
1242
1232
Field Name | Type | Description
1243
1233
---|:---:|---
1244
1234
<a name="contentType"></a>Content-Type | `string` | **Required.** The content-type to use for encoding a specific property.
1235
+
<a name="style"></a>Style | `string` | The content-type to use for encoding a specific property. See (#parameterContent) for details on the `style` property
1236
+
<a name="explode"></a>explode | `boolean` | When this is true, property values of type `array` or `object` generate seperate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. The default value is false.
1237
+
<a name="contentType"></a>Content-Type | `string` | **Required.** The content-type to use for encoding a specific property.
1245
1238
1246
1239
This object can be extended with [Specification Extensions](#specificationExtensions).
0 commit comments