Move applicability keywords from Validation to Core #572
Conversation
This file contains hidden or 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 reworks both Overview sections in preparation for moving the applicators to Core. The Core overview now covers the generic capabilities (assertion, annotation, and vocabularies), leaving the Validation overview to simply reference the concepts. Rather than noting the standard vocabularies in the top-level Core overview, they are moved in with the overview of vocabularies. Validation and basic meta-data are listed as separate vocabularies, which is consistent with how they have been described to date. Exactly how "format" and the "content*" keywords are classified into vocabularies will be finalized in future commits. The applicators are mentioned as a separate vocabulary in the core spec, although they are not moved over yet in this commit. The descriptive text about applicators which is removed from the Validation overview in this commit will be restored to the Core spec when the vocabulary is moved. There is some duplications as well as the above-mentioned ommission as a result of this change, which will be addressed in subsequent commits.
This adds applicators to the list of keyword types, splits the boolean schemas into their own section, and promotes the "MUST be an object or a boolean" paragraph to the containing section's introduction.
A bit of it moves into the vocabulary section of the Overview, while the rest moves into "Extending JSON Schema" which already covered individual keyword extensions. There will befurther work in this area before the next publication as we formalize the vocabulary concept.
This just moves text, with the bare minimum title, link target, and indentation changes necessary to make it fit in the core spec. The Applicability overview section becomes the intro to the applicability vocabulary, which is followed by the keywords. Further commits will rework the wording for the new arrangement and probably further re-organize the applicability overview. Note that "dependencies" is left in the validation spec, as splitting it is more complex and will be done entirely separately after the basic applicability move is complete.
The prior commits just moved this text over, this commit updates the text to make sense for the new location and structure. In particular, this removes the focus on validation as the applicator vocabulary is more fundamental.
...for the move of applicators to core.
dlax
approved these changes
Mar 24, 2018
jsonschema-core.xml
Outdated
| <t> | ||
| An instance can only fail an assertion that is present in the schema. | ||
| In some cases, this no-op behavior is identical to a keyword that exists with | ||
| certain values, and keyword defintions SHOULD note such values where known. |
jsonschema-core.xml
Outdated
| <section title="Subschema Application"> | ||
| <t> | ||
| This vocabulary provides keywords for applying subschemas to the | ||
| instance in various ways. It is defined in this document, and |
There was a problem hiding this comment.
It might be helpful to insert an xref pointing to "A Vocabulary for Applying Subschemas" section in this document here.
PR review feedback
|
Fixed both comments. @dlax since you approved this and the fixes were trivial, I'm going to go ahead and merge assuming the build checks pass. |
Move the main text into core, and just reference it from validation.
|
...and I realized I forgot to update regular expression concerns. @dlax and/or @Relequestual, please review the last commit and re-approve. |
dlax
approved these changes
Apr 4, 2018
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 primarily addresses #513, although a fair amount of groundwork was needed for the moved keywords to make sense. The move itself is pretty trivial. The commits are organized to make this feasible to review.