Skip to content

Commit 9152df6

Browse files
committed
Merge remote-tracking branch 'refs/remotes/origin/OpenAPI.next' into dm/components
# Conflicts: # versions/3.0.md
2 parents 7641485 + 1425dba commit 9152df6

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

versions/3.0.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ For example, if a field has an array value, the JSON array representation will b
108108
}
109109
```
110110

111-
While the API is described using JSON it does not impose a JSON input/output to the API itself.
111+
While the API is described using JSON, it does not impose a JSON input/output to the API itself.
112112

113113
All field names in the specification are **case sensitive**.
114114

@@ -213,7 +213,7 @@ Field Name | Type | Description
213213
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
214214
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
215215
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
216-
<a name="infoVersion"></a>version | `string` | **Required** The version of the API definition (which is distinct from the OpenAPI specification version or the API implementation version).
216+
<a name="infoVersion"></a>version | `string` | **Required.** The version of the API definition (which is distinct from the OpenAPI specification version or the API implementation version).
217217

218218

219219
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -741,7 +741,7 @@ Field Name | Type | Description
741741
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
742742
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
743743
<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.
744-
<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).
744+
<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).
745745
<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.
746746
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
747747
<a name="operationCallbacks"></a>callbacks | [Callbacks Object](#callbacksObject) | The list of possible callbacks as they are returned from executing this operation.
@@ -1095,7 +1095,7 @@ Field Name | Type | Description
10951095
Field Pattern | Type | Description
10961096
---|:---:|---
10971097
<a name="requestBodyRepresentation"></a>`*` | [Schema Object](#schemaObject) | The schema defining the request body.
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 [Vendor Extensions](#vendorExtensions) for further details.
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.
10991099

11001100

11011101
##### Request Body Examples
@@ -1253,7 +1253,7 @@ Field Name | Type | Description
12531253
##### Patterned Fields
12541254
Field Pattern | Type | Description
12551255
---|:---:|---
1256-
<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 [Vendor Extensions](#vendorExtensions) for further details.
1256+
<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.
12571257

12581258
##### Content Type Examples
12591259

@@ -1405,28 +1405,14 @@ In scenarios where more control is needed over the Content-Type for `multipart`
14051405

14061406
#### <a name="encodingObject"></a>Encoding Object
14071407

1408-
An object representing multipart region encoding for `requestBody` objects
1408+
An object representing multipart region encoding for `requestBody` objects.
14091409

14101410
##### Patterned Fields
14111411
Field Pattern | Type | Description
14121412
---|:---:|---
1413-
<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.
1413+
<a name="encodingProperty"></a>{property} | [Encoding Property Object](#encodingPropertyObject) | The property name to which the special encoding are applied. This field MUST exist in the schema as a property.
14141414

1415-
#### <a name="encoding"></a>Encoding
1416-
1417-
A single encoding definition applied to a single schema property
1418-
1419-
##### Fixed Fields
1420-
Field Name | Type | Description
1421-
---|:---:|---
1422-
<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.
1423-
<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.
1424-
<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.
1425-
<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`.
1426-
1427-
This object can be extended with [Specification Extensions](#specificationExtensions).
1428-
1429-
##### Encoding Object Examples
1415+
##### Encoding Object Example
14301416

14311417
```yaml
14321418
requestBody:
@@ -1461,6 +1447,20 @@ requestBody:
14611447
contentType: image/png, image/jpeg
14621448
```
14631449

1450+
#### <a name="encodingPropertyObject"></a>Encoding Property Object
1451+
1452+
A single encoding definition applied to a single schema property.
1453+
1454+
##### Fixed Fields
1455+
Field Name | Type | Description
1456+
---|:---:|---
1457+
<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.
1458+
<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.
1459+
<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.
1460+
<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`.
1461+
1462+
This object can be extended with [Specification Extensions](#specificationExtensions).
1463+
14641464
#### <a name="responsesObject"></a>Responses Object
14651465

14661466
A container for the expected responses of an operation.
@@ -1920,7 +1920,7 @@ color: ["red", "green", "blue"]
19201920
The variables generated can be used in locations prescribed by the definition.
19211921

19221922

1923-
### <a name="variableSubstitution"></a>Variable substitution
1923+
### <a name="variableSubstitution"></a>Variable Substitution
19241924
In all cases, _variables_ from request and responses may be substituted for link generation.
19251925
The table below provides examples of variable expressions and examples of their use in a value:
19261926

@@ -1956,7 +1956,7 @@ The variable expression is defined by the following [ABNF](https://tools.ietf.or
19561956
The `name` identifier is case-sensitive, whereas `token` is not.
19571957
19581958
1959-
### Request parameter example
1959+
### Request Parameter Example
19601960
Computing a link from a request operation like such:
19611961
19621962
```yaml
@@ -1996,7 +1996,7 @@ For a `id` value of `10101110`, the generated link would be:
19961996
href: '/users/10101110/department'
19971997
```
19981998

1999-
### Response payload example
1999+
### Response Payload Example
20002000

20012001
```yaml
20022002
Addresses:
@@ -3248,7 +3248,7 @@ Field Name | Type | Validity | Description
32483248
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`.
32493249
<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme.
32503250
<a name="securitySchemeName"></a>name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used.
3251-
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required** The ___location of the API key. Valid values are `"query"` or `"header"`.
3251+
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required.** The ___location of the API key. Valid values are `"query"` or `"header"`.
32523252
<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **Required.** The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2).
32533253
<a name="securitySchemeBearerFormat"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
32543254
<a name="securitySchemeFlow"></a>flow | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **Required.** An object containing configuration information for the flow types supported.
@@ -3501,7 +3501,7 @@ Two examples for this:
35013501

35023502
Version | Date | Notes
35033503
--- | --- | ---
3504-
3.0.0-rc0 | 2017-02-28 | Implementor's draft of the 3.0 specification
3504+
3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification
35053505
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
35063506
2.0 | 2014-09-08 | Release of Swagger 2.0
35073507
1.2 | 2014-03-14 | Initial release of the formal document.

0 commit comments

Comments
 (0)