Skip to content

Commit 0df060a

Browse files
committed
applied feedback from OAI TDC call
1 parent c5380d3 commit 0df060a

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

versions/3.0.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
527527
"items": {
528528
"type": "string"
529529
},
530-
"style": "comma-delimited"
530+
"style": "commaDelimited"
531531
}
532532
]
533533
}
@@ -578,7 +578,7 @@ Field Name | Type | Description
578578
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
579579
<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.
580580
<a name="operationParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>&#124;</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>&#124;</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>&#124;</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.
582582
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
583583
<a name="operationCallbacks"></a>callback responses | [Callback Responses Object](#callbackObject) | The list of possible callback responses as they are returned from executing this operation.
584584
<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:
11151115
schema:
11161116
type: string
11171117
format: binary
1118-
1119-
# multiple files:
1120-
schema:
1121-
type: array
1122-
items:
1123-
type: string
1124-
format: binary
11251118
```
11261119

11271120
Note that the above examples apply to either input payloads (i.e. file uploads) or response payloads.
11281121

1129-
11301122
A `requestBody` example for submitting a file in a `POST` operation therefore may look like the following:
11311123

11321124
```yaml
@@ -1230,9 +1222,7 @@ An object representing multipart region encoding for `requestBody` objects
12301222
##### Patterned Fields
12311223
Field Pattern | Type | Description
12321224
---|:---:|---
1233-
<a name="encodingObjectProperty"></a>The property to apply encoding to | [Encoding Property](#encodingProperty) <span>&#124;</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>&#124;</span> [Encoding](#encoding) | The field name to apply special encoding attributes to. This field must exist in the schema as a property.
12361226

12371227
#### <a name="encoding"></a>Encoding
12381228

@@ -1242,6 +1232,9 @@ A single encoding definition applied to a single schema property
12421232
Field Name | Type | Description
12431233
---|:---:|---
12441234
<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.
12451238

12461239
This object can be extended with [Specification Extensions](#specificationExtensions).
12471240

0 commit comments

Comments
 (0)