schema: preserve None for all enumeration fields#98
Open
spikespaz wants to merge 1 commit intoglademiller:masterfrom
Open
schema: preserve None for all enumeration fields#98spikespaz wants to merge 1 commit intoglademiller:masterfrom
spikespaz wants to merge 1 commit intoglademiller:masterfrom
Conversation
This change preserves a distinction made by OAS, between an uninhabited schema versus one without `enum` restriction. Per the spec: > This array SHOULD have at least one element. > ... > An instance validates successfully against this keyword if its value > is equal to one of the elements in this keyword's array value. Reference: <https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-5.20> This implies that if the keyword `enum` is omitted, the schema imposes no enumeration constraint. Conversely, if the keyword is present but its array is empty, the schema is uninhabited, as no instance can satisfy an empty enumeration. OAS 3.0.4 does not change the interpretation of this keyword. Reference: <https://spec.openapis.org/oas/v3.0.4.html#x4-7-24-1-json-schema-keywords>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 change preserves a distinction made by OAS,
between an uninhabited schema versus one without
enumrestriction.Per the spec:
Reference:
https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-5.20
This implies that if the keyword
enumis omitted, the schema imposes no enumeration constraint. Conversely, if the keyword is present but its array is empty, the schema is uninhabited, as no instance can satisfy an empty enumeration.OAS 3.0.4 does not change the interpretation of this keyword. Reference:
https://spec.openapis.org/oas/v3.0.4.html#x4-7-24-1-json-schema-keywords