Removed Headers Object
MODIFY
versions/3.0.md
versions/3.0.md
@@ -49,7 +49,6 @@ Additional utilities can also take advantage of the resulting files, such as tes
- [Responses Object](#responsesObject)
- [Response Object](#responseObject)
- [Callback Object](#callbackObject)
- - [Headers Object](#headersObject)
- [Example Object](#exampleObject)
- [Links Object](#linksObject)
- [Link Object](#linkObject)
@@ -1637,7 +1636,7 @@ Describes a single response from an API Operation, including design-time, static
Field Name | Type | Description
---|:---:|---
<a name="responseDescription"></a>description | `string` | **Required.** A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
-<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored.
+<a name="responseHeaders"></a>headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | Maps a header name to its definition. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored.
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
@@ -1834,56 +1833,6 @@ myWebhook:
```
-#### <a name="headersObject"></a>Headers Object
-Lists the headers that can be sent in a response or forwarded via a link. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive.
-
-##### Patterned Fields
-Field Pattern | Type | Description
----|:---:|---
-<a name="headersName"></a>{name} | [Header Object](#headerObject) \| [Reference Object](#referenceObject) | The name of the property corresponds to the name of the header. The value describes the type of the header.
-
-##### Headers Object Example
-
-Rate-limit headers:
-
-```json
-{
- "X-Rate-Limit-Limit": {
- "description": "The number of allowed requests in the current period",
- "schema": {
- "type": "integer"
- }
- },
- "X-Rate-Limit-Remaining": {
- "description": "The number of remaining requests in the current period",
- "schema": {
- "type": "integer"
- }
- },
- "X-Rate-Limit-Reset": {
- "description": "The number of seconds left in the current period",
- "schema": {
- "type": "integer"
- }
- }
-}
-```
-
-```yaml
-X-Rate-Limit-Limit:
- description: The number of allowed requests in the current period
- schema:
- type: integer
-X-Rate-Limit-Remaining:
- description: The number of remaining requests in the current period
- schema:
- type: integer
-X-Rate-Limit-Reset:
- description: The number of seconds left in the current period
- schema:
- type: integer
-```
-
#### <a name="exampleObject"></a>Example Object
##### Fixed Fields
@@ -1985,7 +1934,7 @@ Field Name | Type | Description
<a name="linkOperationRef"></a>operationRef | `string` | a relative or absolute reference to an OAS operation. This field is mutually exclusive with the `operationId` field, and must point to the fragment of a valid OAS definition.
<a name="linkOperationId"></a>operationId | `string` | the name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive with the `operationRef` field. Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operationObject) in the OAS.
<a name="linkParameters"></a>parameters | [Link Parameters Object](#linkParametersObject) | an object representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`.
-<a name="linkHeaders"></a>headers | [Headers Object](#headersObject) | an object representing headers to pass to the linked resource. Where conflicts occur between these headers, and those defined in the related operation, these headers override.
+<a name="linkHeaders"></a>headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | Maps a header name to its definition. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. This represents the headers to pass to the linked resource. Where conflicts occur between these headers, and those defined in the related operation, these headers override.
<a name="linkDescription"></a>description | `string` | a description of the link, supports [CommonMark syntax](http://spec.commonmark.org/).
<a name="linkServer"></a>server | [Server Object](#serverObject) | a server object to be used by the target operation.
@@ -2419,7 +2368,7 @@ In the above, the link for `UserCommitHistory` points to the operation `getUserC
The Header Object follows the structure of the [Parameter Object](#parameterObject), with the following changes:
-1. `name` MUST NOT be specified, it is given in the [Headers Object](#headersObject).
+1. `name` MUST NOT be specified, it is given in the corresponding `headers` map.
1. `in` MUST NOT be specified, it is implicitly in `header`.
1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, [`style`](#parameterStyle)).

Removed Headers Object