Skip to content

Commit 9f39cd9

Browse files
committed
Update versions/3.0.md based on mdv issues
1 parent d232e6d commit 9f39cd9

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

versions/3.0.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Types that are not accompanied by a `format` property follow their definition fr
146146
The formats defined by the OAS are:
147147

148148

149-
Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments
149+
Common Name | [`type`](#dataTypes) | [`format`](#dataTypeFormat) | Comments
150150
----------- | ------ | -------- | --------
151151
integer | `integer` | `int32` | signed 32 bits
152152
long | `integer` | `int64` | signed 64 bits
@@ -657,7 +657,7 @@ Field Name | Type | Description
657657
<a name="pathItemPatch"></a>patch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path.
658658
<a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path.
659659
<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>&#124;</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>&#124;</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).
661661

662662

663663
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -756,7 +756,7 @@ Field Name | Type | Description
756756
<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.
757757
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
758758
<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>&#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).
759+
<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 components/parameters](#componentsParameters).
760760
<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.
761761
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
762762
<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
947947

948948
In order to support common ways of serializing simple parameters, a set of `style` values are defined.
949949

950-
`style` | [`type`](#dataTypeType) | `in` | Comments
950+
`style` | [`type`](#dataTypes) | `in` | Comments
951951
----------- | ------ | -------- | --------
952952
matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7)
953953
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:
11941194

11951195
#### <a name="contentObject"></a>Content Object
11961196

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),
11981198
[Parameter Objects](#parameterObject), [Header Objects](#headerObject), and [Response Objects](#responseObject).
11991199

12001200
Each key in the Content Object is the media type of the [Media Type Object](#mediaTypeObject).
@@ -1489,12 +1489,12 @@ Field Name | Type | Description
14891489
---|:---:|---
14901490
<a name="responsesDefault"></a>default | [Response Object](#responseObject) <span>&#124;</span> [Reference Object](#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes.
14911491
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.
14931493

14941494
##### Patterned Fields
14951495
Field Pattern | Type | Description
14961496
---|:---:|---
1497-
<a name="responsesCode"></a>[HTTP Status Code](#httpCodes) | [Response Object](#responseObject) <span>&#124;</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>&#124;</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]`.
14981498

14991499

15001500
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
16801680
##### Patterned Fields
16811681
Field Pattern | Type | Description
16821682
---|:---:|---
1683-
<a name="callbackName"></a>{name} | [Callback Object](#callbackObject) <span>&#124;</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>&#124;</span> [Reference Object](#referenceObject) | A Callback Object used to define a callback request and expected responses
16841684

16851685
This object can be extended with [Specification Extensions](#specificationExtensions).
16861686

@@ -1853,7 +1853,7 @@ Field Pattern | Type | Description
18531853
<a name="linkName"></a> {name} | [Link Object](#linkObject) <span>&#124;</span> [Reference Object](#referenceObject) | A short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject).
18541854
The link SHALL reference a single Link Object, or a JSON Reference to a single link object.
18551855

1856-
#### <a name="#linkObject"></a>Link Object
1856+
#### <a name="linkObject"></a>Link Object
18571857
The `Link Object` is responsible for defining a possible operation based on a single response.
18581858

18591859
Field Name | Type | Description

0 commit comments

Comments
 (0)