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

Provide guidance on using OAS with Overlay and Arazzo #4221

Open
handrews opened this issue Nov 21, 2024 · 1 comment
Open

Provide guidance on using OAS with Overlay and Arazzo #4221

handrews opened this issue Nov 21, 2024 · 1 comment
Labels
clarification requests to clarify, but not change, part of the spec
Milestone

Comments

@handrews
Copy link
Member

Many long-requested features for OAS can now be better handled by using the Overlay and/or Arazzo specifications.

I think Arazzo mostly overlaps with the Link Object, but I might be wrong there. Some guidance as to when to use which would probably be good to add.

Overlays solve many requests for global or default values, and if it is reasonably straightforward to do that, we should include info in the OAS pointing to the Overlay spec for that use case. Other use cases include various reference-and-modify constructs (hmm.. do we want to consider pushing this instead of the adjacent-fields-in-Reference-Object approach?)

Putting this in the next patch release, although there may be additional things to do in minor releases here.

@handrews handrews added the clarification requests to clarify, but not change, part of the spec label Nov 21, 2024
@handrews handrews added this to the v3.1.2 milestone Nov 21, 2024
@jeremyfiel
Copy link
Contributor

I think Overlay usage is a great target for the many language localization requests over the years.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec
Projects
None yet
Development

No branches or pull requests

2 participants