Uh oh!
There was an error while loading. Please reload this page.
Add link support from urls - #3269
Closed
mikekistler wants to merge 1 commit into
Closed
Conversation
mikekistler
commented
May 8, 2023
| 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. | ||
Author
There was a problem hiding this comment.
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.
| <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. |
Member
There was a problem hiding this comment.
Suggested change
| <aname="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. | |
| <aname="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. |
handrews
commented
Feb 16, 2024
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
commented
Feb 16, 2024
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds the
urlfield to the Link Object. This allows a Link to express the relationship between a URL returned in a response, such asLocationto a corresponding operation, which may use the URL directly or as the source of path or query parameter values.