Explain referenced/referring schemas #609
Merged
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
For several upcoming features, we need better language to talk about the schemas on either side of a "$ref" or similar linking keyword. In particular, annotation collection interacts with references, and calling referenced schemas "subschemas" is confusing and technically inaccurate.
gregsdennis
reviewed
Jun 17, 2018
| with an instance. | ||
| <cref> | ||
| Assuming some form of dynamic reference keyword is introduced | ||
| related to GitHub issue #558, this section will be updated |
There was a problem hiding this comment.
Do we need to specify the repo here? If it's specified elsewhere in the doc, then probably not.
There was a problem hiding this comment.
It's linked in the "Note to Readers" section near the very top. In past CREFs we have just used issue numbers. I only reference issues in CREFs, and I don't worry about the formality of those as much as they're intended as asides that will be removed.
handrews
changed the title
dlax
approved these changes
Jun 18, 2018
Relequestual
approved these changes
Jun 27, 2018
| <xref target="ref">"$ref"</xref>, the referred schema can be determined | ||
| by static analysis of the schema document. Others may take evaluation | ||
| context into account, and only be resolvable in the process of evaluating | ||
| with an instance. |
There was a problem hiding this comment.
This is great! Really adds clarity.
|
@handrews I think this can now be merged. There's nothing contravertial here. |
gregsdennis
added
clarification
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.
For several upcoming features, we need better language to
talk about the schemas on either side of a "$ref" or similar
linking keyword.
In particular, annotation collection (#530) interacts with references,
and calling referenced schemas "subschemas" is confusing and
technically inaccurate.