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
+5-12Lines changed: 5 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,6 @@ Additional utilities can also take advantage of the resulting files, such as tes
50
50
- [Response Object](#responseObject)
51
51
- [Callback Object](#callbackObject)
52
52
- [Example Object](#exampleObject)
53
-
- [Links Object](#linksObject)
54
53
- [Link Object](#linkObject)
55
54
- [Link Parameters Object](#linkParametersObject)
56
55
- [Header Object](#headerObject)
@@ -1638,7 +1637,7 @@ Field Name | Type | Description
1638
1637
<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.
1639
1638
<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.
1640
1639
<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).
1642
1641
1643
1642
This object can be extended with [Specification Extensions](#specificationExtensions).
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.
1916
1917
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.
1917
1918
1918
1919
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.
1919
1920
1920
1921
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.
1921
1922
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.
0 commit comments