Drop ineffective requiredProperties #34
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
The schema here attempted to require certain properties, but this had no effect because the correct keyword is "required", not "requiredProperties". This can be confirmed at http://json-schema.org/draft-07/schema. So, in reality we have never required any properties here. We could now change this to "required" to match the original intent, but I think it's reasonable to just drop them instead since: - adding new required properties is backwards-incompatible. In the worst-case scenario it breaks some services; in the best case it probably breaks at least some tests. - it anyway seems more user-friendly to allow these fields to be omitted, since they always have some obvious default value which could be provided (such as an empty list or dict). These could even be filled in by the library automatically on load, though this is not pursued at the moment.
crungehottman
approved these changes
Sep 22, 2021
rajulkumar
approved these changes
Sep 22, 2021
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.
The schema here attempted to require certain properties, but this had no
effect because the correct keyword is "required", not
"requiredProperties". This can be confirmed at
http://json-schema.org/draft-07/schema.
So, in reality we have never required any properties here.
We could now change this to "required" to match the original intent,
but I think it's reasonable to just drop them instead since:
adding new required properties is backwards-incompatible. In the
worst-case scenario it breaks some services; in the best case it
probably breaks at least some tests.
it anyway seems more user-friendly to allow these fields to be
omitted, since they always have some obvious default value
which could be provided (such as an empty list or dict). These could
even be filled in by the library automatically on load, though this
is not pursued at the moment.