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

Are Overlays restricted to operate on OpenAPI documents? #56

Open
ralfhandl opened this issue Sep 11, 2024 · 0 comments
Open

Are Overlays restricted to operate on OpenAPI documents? #56

ralfhandl opened this issue Sep 11, 2024 · 0 comments
Labels
clarification requests to clarify, but not change, part of the spec
Milestone

Comments

@ralfhandl
Copy link
Contributor

Do we want to restrict Overlays to only operate on OpenAPI documents? For the most part the spec could easily be applied to any JSON or YAML doc. And in several places we seem to allow base documents of other types, e.g. target is described as

URL to the target document (such as an [[OpenAPI]] document) ...

On the other hand the original scope described in README.md is

The Overlay specification defines a way of creating documents that contain information to be merged with an OpenAPI description at some later point in time, for the purpose of updating the OpenAPI description with additional information.

@ralfhandl ralfhandl added this to the Release 2.0 milestone Sep 11, 2024
@ralfhandl ralfhandl added the clarification requests to clarify, but not change, part of the spec label Sep 11, 2024
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

1 participant