Replies: 3 comments 11 replies
-
|
Arazzo doesn't use it that I know of. With Arazzo I don't see why it is needed any longer in the OAS spec. We have discussed this some time back as well and though it was a while ago I am pretty sure Arazzo does a lot more than Links do and is one of the primary reasons for the spec, ability to define workflow request chains.. but adds the ability to utilize requests across APIs so unlike Links it's not relegated to a single API description. |
Beta Was this translation helpful? Give feedback.
-
|
I can confirm that there's no use of the OAS Link Object within Arazzo. At one point we had discussed loose verbiage mentioning that Link Objects defined within a referenced OpenAPI Description may have influence on the workflow but as that was a little too ambiguous and because we could not determine a clear use case where both Arazzo and OAS Link Objects would be used in unison, we did included anything into Arazzo. It's a good conversation to have and determine a path forward. I tend to agree with Kevin that it can help shine a light on where Arazzo can play an important role while also ensuring we done create unnecessary overlap between the specs. |
Beta Was this translation helpful? Give feedback.
-
|
@frankkilcommins @kevinduffey thanks, this helps! One use case I've been thinking of is as a fallback for implementing complex auth flows. We'd love to have elegant Security Scheme solutions for every possible form of auth. But even when those indicate that another specification such as OAuth2 or OIDC is to be used, there are often gaps in the steps that we don't document well. It's occurred to me to wonder if it might make sense to allow documenting those steps as "normal" HTTP interactions (which is a fairly complex idea that may or may not be the right approach, but will be discussed in the OAS repo) and use Arazzo to document show the full authentication/authorization workflow. Which brings up another thought- are there times when an OAD would want to reference an Arazzo document, instead of (or in addition to) the other way aroudn? Like... "if you want to use these endpoints, go look over here." That could be another way to draw attention to Arazzo. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi folks,
As we start planning for OAS v3.3, I'm looking at several proposals or complaints about the Link Object. Does Arazzo make any use of it? Is it redundant now that we have Arazzo? Or could it be useful, perhaps with some improvements?
I don't know that it would get prioritized for 3.3, but there's at least some conceptual overlap and it would be good to figure out if we ought to more-or-less deprecate the Link Object in favor of Arazzo.
Beta Was this translation helpful? Give feedback.
All reactions