Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link support from urls #3269

Closed
wants to merge 1 commit into from

Conversation

mikekistler
Copy link
Contributor

This PR adds the url field to the Link Object. This allows a Link to express the relationship between a URL returned in a response, such as Location to a corresponding operation, which may use the URL directly or as the source of path or query parameter values.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Clients follow all links at their discretion.
Neither permissions, nor the capability to make a successful call to that link, is guaranteed
solely by the existence of a relationship.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved this text from within the first example description to the main description of the Link Object to indicate that it applies generally and not just to that specific example.

@@ -2039,6 +2043,7 @@ Field Name | Type | Description
<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 of the `operationRef` field.
<a name="linkParameters"></a>parameters | Map[`string`, Any \| [{expression}](#runtimeExpression)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id).
<a name="linkRequestBody"></a>requestBody | Any \| [{expression}](#runtimeExpression) | A literal value or [{expression}](#runtimeExpression) to use as a request body when calling the target operation.
<a name="linkUrl"></a>url | Any \| {expression} | A constant or an expression to be evaluated and passed to the linked operation. The value should be a URL for the linked operation. Applications may extract values for path or query parameters present in this URL to use as values for these parameters in the linked operation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a name="linkUrl"></a>url | Any \| {expression} | A constant or an expression to be evaluated and passed to the linked operation. The value should be a URL for the linked operation. Applications may extract values for path or query parameters present in this URL to use as values for these parameters in the linked operation.
<a name="linkUrl"></a>url | `string` \| {expression} | A constant or an expression to be evaluated and passed to the linked operation. The value SHOULD evaluate to be a URL that matches? the linked operation. Applications may extract values for path or query parameters present in this URL to use as values for these parameters in the linked operation.

@Saud96525 Saud96525 linked an issue May 30, 2023 that may be closed by this pull request
@handrews handrews added the links label Jan 29, 2024
@handrews
Copy link
Member

@darrelmiller @mikekistler what was the status and context of this PR? Was the change agreed-to in principle already, or is this a PR-as-proposal? Is it something we can finish up quickly or should it be moved back to an issue for deeper discussion?

@mikekistler
Copy link
Contributor Author

Sadly I think this PR is dead. Based on discussions on this in the TDC meetings, I think it is fair to say that OpenAPI v3 links are too ill-defined to make any attempt to extend them fruitful. I'll close this out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tbarn:coc-enforcement-doc
3 participants