Add guidance on bundling and references #792
Closed
Conversation
This file contains 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
This is going to be a powerful technique for generative use cases, which have been observed either requiring references (as opposed to subschemas) in certain places, or implementing various sorts of inferencing around references on their own or in conjunction with other keywords. For example, one OpenAPI documentation tool assumes that in an "allOf" of several references, the first is a base class of some sort. While this is not correct behavior by either JSON Schema or OpenAPI, it demonstrates a feature built by making implicit assumptions about certain references. This section provides a recommendation for making such behavior explicit, and also guides writers of such tools to the concept of extension vocabularies and annotations.
philsturgeon
approved these changes
Aug 26, 2019
Relequestual
approved these changes
Sep 5, 2019
philsturgeon
approved these changes
Sep 8, 2019
This should make clear what use cases are considered valid and safe, vs when someone is on their own in terms of figuring that out.
Co-Authored-By: Phil Sturgeon <[email protected]>
|
I've moved these commits over to #791 along with the commits for #793 in order to tidy up how all of these stacked PRs need to merge. At this point, everything in #791 (which includes #792 and #793 now) was approved in its original PR by @Relequestual and/or @philsturgeon . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 should make clear what use cases are considered valid
and safe, vs when someone is on their own in terms of figuring
that out.