Clarify discriminator "*Of" and "mapping" usage (3.0.4) #3822
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 moves some guidance up to the fixed fields section where it is more obvious, and explicitly designates other configurations as having undefined behavior.
handrews
added
discriminator
clarification
This creates subsections to organize the different topics, pulls key guidance out of the examples and up into those sections, and provides clarification on the ambiguity of names and URIs.
handrews
changed the title
This was referenced May 22, 2024
mikekistler
approved these changes
May 23, 2024
Contributor
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
One little nit, otherwise Looks good! 👍
Co-authored-by: Mike Kistler <[email protected]>
ralfhandl
approved these changes
May 23, 2024
miqui
added a commit
that referenced
this pull request
Jun 4, 2024
Clarify discriminator + oneOf/anyOf/allOf usage (3.1.1 modified port of #3822)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes:
discriminatorusage onallOfschemas. #3424This moves some guidance up to the fixed fields section where it is more obvious, makes it clear that
allOfis used differently fromanyOf/oneOf, and explicitly designates other configurations as having undefined behavior. It also reworks the somewhat cryptic statement about "inline" schemas, and provides guidance around ambiguousmappingvalues.