Skip to content

Commit 702f44a

Browse files
committed
Removed Links Object
1 parent b228c46 commit 702f44a

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

versions/3.0.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ Additional utilities can also take advantage of the resulting files, such as tes
5050
- [Response Object](#responseObject)
5151
- [Callback Object](#callbackObject)
5252
- [Example Object](#exampleObject)
53-
- [Links Object](#linksObject)
5453
- [Link Object](#linkObject)
5554
- [Link Parameters Object](#linkParametersObject)
5655
- [Header Object](#headerObject)
@@ -1638,7 +1637,7 @@ Field Name | Type | Description
16381637
<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.
16391638
<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.
16401639
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
1641-
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
1640+
<a name="responseLinks"></a>links | Map[`string`, [Link Object](#linkObject) \| [Reference Object](#referenceObject)] | A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject).
16421641

16431642
This object can be extended with [Specification Extensions](#specificationExtensions).
16441643

@@ -1911,22 +1910,16 @@ schemas:
19111910
$ref: '#/components/examples/confirmation-success'
19121911
```
19131912

1914-
#### <a name="linksObject"></a>Links Object
1915-
The links object represents a set of possible design-time links for a response.
1913+
1914+
#### <a name="linkObject"></a>Link Object
1915+
1916+
The `Link object` represents a possible design-time link for a response.
19161917
The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
19171918

19181919
As opposed to _dynamic_ links (links provided **in** the response payload), the OAS linking mechanism does not require that link information be provided in a specific response format at runtime.
19191920

19201921
For computing links, and providing instructions to execute them, [variable substitution](#variableSubstitution) is used for accessing values in a response and using them as values while invoking the linked operation.
19211922

1922-
##### Patterned Fields
1923-
Field Pattern | Type | Description
1924-
---|:---:|---
1925-
<a name="linksName"></a> {name} | [Link Object](#linkObject) \| [Reference Object](#referenceObject) | A short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject). The link SHALL reference a single Link Object, or a JSON Reference to a single link object.
1926-
1927-
#### <a name="linkObject"></a>Link Object
1928-
The `Link Object` is responsible for defining a possible operation based on a single response.
1929-
19301923
##### Fixed Fields
19311924

19321925
Field Name | Type | Description

0 commit comments

Comments
 (0)