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
{{ message }}
This repository was archived by the owner on May 30, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: versions/3.0.md
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1867,17 +1867,19 @@ The `Link Object` is responsible for defining a possible operation based on a si
1867
1867
1868
1868
Field Name | Type | Description
1869
1869
---|:---:|---
1870
-
href | `string` | a relative or absolute URL to a linked resource. This field is mutually exclusive with the `operationId` field.
1870
+
operationRef | `string` | a relative or reference to an OAS operation. This field is mutually exclusive with the `operationId` field.
1871
1871
operationId | `string` | the name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive with the `href` field. Relative `href` values MAY be used to locate an existing [Operation Object](#operationObject) in the OAS.
1872
1872
parameters | [Link Parameters Object](#linkParametersObject) | an object representing parameters to pass to an operation as specified with `operationId` or identified via `href`.
1873
1873
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.
1874
1874
description | `string` | a description of the link, supports [CommonMark syntax](http://spec.commonmark.org/).
1875
+
server | [Server Object](#serverObject) | a server object to be used by the target operation
1875
1876
1876
1877
This object can be extended with [Specification Extensions](#specificationExtensions).
1877
1878
1878
-
Locating a linked resource MAY be performed by either a `href` or `operationId`.
1879
+
Locating a linked resource MAY be performed by either a `operationRef` or `operationId`.
1879
1880
In the case of an `operationId`, it MUST be unique and resolved in the scope of the OAS document.
1880
-
Because of the potential for name clashes, consider the `href` syntax as the preferred method for specifications with external references.
1881
+
Because of the potential for name clashes, consider the `operationRef` syntax as the preferred
1882
+
method for specifications with external references.
0 commit comments