Skip to content
This repository was archived by the owner on Jul 1, 2021. It is now read-only.

Commit 7e5693e

Browse files
committed
added explanation, fixes for OAI#1039
1 parent 321bc4e commit 7e5693e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

versions/3.0.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1867,17 +1867,19 @@ The `Link Object` is responsible for defining a possible operation based on a si
18671867

18681868
Field Name | Type | Description
18691869
---|:---:|---
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.
18711871
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.
18721872
parameters | [Link Parameters Object](#linkParametersObject) | an object representing parameters to pass to an operation as specified with `operationId` or identified via `href`.
18731873
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.
18741874
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
18751876

18761877
This object can be extended with [Specification Extensions](#specificationExtensions).
18771878

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`.
18791880
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.
18811883

18821884
##### <a name="responsePayload"></a>Response Payload Values
18831885

0 commit comments

Comments
 (0)