"required" JSON keys are validated against "additionalProperties" if they are missing from "properties" #1029
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
…t additionalProperties
hudson-ai
commented
Sep 16, 2024
|
|
||
| if additional_properties is not False: | ||
| if additional_properties is True: |
There was a problem hiding this comment.
Not a functional change -- this line is just no longer needed since _gen_json can take bool schemas just fine
hudson-ai
commented
Sep 16, 2024
| # "required" keys will be validated against "properties" if they're present, otherwise against "additionalProperties". | ||
| # If "additionalProperties" is False, then required keys must be in "properties". | ||
| if any(k not in properties for k in required) and additional_properties is False: | ||
| raise ValueError( |
There was a problem hiding this comment.
Not strictly necessary, as generating with a False schema will raise an exception later. But this lets us give a more transparent error.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #1029 +/- ##
==========================================
- Coverage 70.16% 61.47% -8.69%
==========================================
Files 62 62
Lines 4471 4470 -1
==========================================
- Hits 3137 2748 -389
- Misses 1334 1722 +388 ☔ View full report in Codecov by Sentry. |
riedgar-ms
approved these changes
Sep 18, 2024
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.
Rather than raising an exception when
requiredproperties don't have a schema inproperties, validate againstadditionalProperties(consistent with Draft202012)Somewhat arbitrarily set key order of resulting objects to:
propertiesin orderrequiredproperties mising frompropertiesin orderadditionalProperties