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
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ Types that are not accompanied by a `format` property follow their definition fr
146
146
The formats defined by the OAS are:
147
147
148
148
149
-
Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments
149
+
Common Name | [`type`](#dataTypes) | [`format`](#dataTypeFormat) | Comments
150
150
----------- | ------ | -------- | --------
151
151
integer | `integer` | `int32` | signed 32 bits
152
152
long | `integer` | `int64` | signed 64 bits
@@ -657,7 +657,7 @@ Field Name | Type | Description
657
657
<a name="pathItemPatch"></a>patch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path.
658
658
<a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path.
659
659
<a name="pathItemServers"></a>servers | [Server Object](#serverObject) | An alternative `server` array to service all operations in this path.
660
-
<a name="pathItemParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>|</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. 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).
660
+
<a name="pathItemParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>|</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. 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 components/parameters](#componentsParameters).
661
661
662
662
663
663
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -756,7 +756,7 @@ Field Name | Type | Description
756
756
<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.
757
757
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
758
758
<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.
759
-
<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).
759
+
<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 components/parameters](#componentsParameters).
760
760
<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.
761
761
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
762
762
<a name="operationCallbacks"></a>callbacks | [Callbacks Object](#callbacksObject) | The list of possible callbacks as they are returned from executing this operation.
@@ -947,7 +947,7 @@ Field Name | Type | Description
947
947
948
948
In order to support common ways of serializing simple parameters, a set of `style` values are defined.
matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7)
953
953
label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5)
@@ -1194,7 +1194,7 @@ content:
1194
1194
1195
1195
#### <a name="contentObject"></a>Content Object
1196
1196
1197
-
Describes a set of supported media types. A Content Object can be used in [Request Body Object](#requestBody),
1197
+
Describes a set of supported media types. A Content Object can be used in [Request Body Object](#requestBodyObject),
1198
1198
[Parameter Objects](#parameterObject), [Header Objects](#headerObject), and [Response Objects](#responseObject).
1199
1199
1200
1200
Each key in the Content Object is the media type of the [Media Type Object](#mediaTypeObject).
@@ -1489,12 +1489,12 @@ Field Name | Type | Description
1489
1489
---|:---:|---
1490
1490
<a name="responsesDefault"></a>default | [Response Object](#responseObject) <span>|</span> [Reference Object](#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes.
1491
1491
It can be used to cover undeclared responses.
1492
-
[Reference Object](#referenceObject) can be used to link to a response that is defined at the [OpenAPI Object's responses](#oasResponses) section.
1492
+
[Reference Object](#referenceObject) can be used to link to a response that is defined at the [OpenAPI Object's components/responses](#componentsResponses) section.
1493
1493
1494
1494
##### Patterned Fields
1495
1495
Field Pattern | Type | Description
1496
1496
---|:---:|---
1497
-
<a name="responsesCode"></a>[HTTP Status Code](#httpCodes) | [Response Object](#responseObject) <span>|</span> [Reference Object](#referenceObject) | Any [HTTP status code](#httpCodes) can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. [Reference Object](#referenceObject) can be used to link to a response that is defined at the [OpenAPI Object's responses](#oasResponses) section. This field MUST be quoted for compatibility between JSON and YAML (i.e. "200"), and MAY contain the uppercase character, `X` to designate a wildcard, such as `2XX` to represent all response codes between `[200-299]`.
1497
+
<a name="responsesCode"></a>[HTTP Status Code](#httpCodes) | [Response Object](#responseObject) <span>|</span> [Reference Object](#referenceObject) | Any [HTTP status code](#httpCodes) can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. [Reference Object](#referenceObject) can be used to link to a response that is defined at the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be quoted for compatibility between JSON and YAML (i.e. "200"), and MAY contain the uppercase character, `X` to designate a wildcard, such as `2XX` to represent all response codes between `[200-299]`.
1498
1498
1499
1499
1500
1500
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -1680,7 +1680,7 @@ The key value used to identify the callback object is an expression, evaluated a
1680
1680
##### Patterned Fields
1681
1681
Field Pattern | Type | Description
1682
1682
---|:---:|---
1683
-
<a name="callbackName"></a>{name} | [Callback Object](#callbackObject) <span>|</span> [Reference Object](#ReferenceObject) | A Callback Object used to define a callback request and expected responses
1683
+
<a name="callbackName"></a>{name} | [Callback Object](#callbackObject) <span>|</span> [Reference Object](#referenceObject) | A Callback Object used to define a callback request and expected responses
1684
1684
1685
1685
This object can be extended with [Specification Extensions](#specificationExtensions).
1686
1686
@@ -1853,7 +1853,7 @@ Field Pattern | Type | Description
1853
1853
<a name="linkName"></a> {name} | [Link Object](#linkObject) <span>|</span> [Reference Object](#referenceObject) | A short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject).
1854
1854
The link SHALL reference a single Link Object, or a JSON Reference to a single link object.
1855
1855
1856
-
#### <a name="#linkObject"></a>Link Object
1856
+
#### <a name="linkObject"></a>Link Object
1857
1857
The `Link Object` is responsible for defining a possible operation based on a single response.
0 commit comments