Skip to content

Clarify discriminator "*Of" and "mapping" usage (3.0.4) - #3822

Merged
ralfhandl merged 4 commits into
OAI:v3.0.4-devfrom
handrews:disc-of-304
May 23, 2024
Merged

Clarify discriminator "*Of" and "mapping" usage (3.0.4)#3822
ralfhandl merged 4 commits into
OAI:v3.0.4-devfrom
handrews:disc-of-304

Conversation

@handrews

@handrewshandrews commented May 19, 2024

Copy link
Copy Markdown
Member

Fixes:

This moves some guidance up to the fixed fields section where it is more obvious, makes it clear that allOf is used differently from anyOf/oneOf, and explicitly designates other configurations as having undefined behavior. It also reworks the somewhat cryptic statement about "inline" schemas, and provides guidance around ambiguous mapping values.

This moves some guidance up to the fixed fields section where
it is more obvious, and explicitly designates other configurations
as having undefined behavior.
@handrewshandrews added discriminator clarification requests to clarify, but not change, part of the spec labels May 19, 2024
@handrewshandrews added this to the v3.0.4 milestone May 19, 2024
@handrews
handrews requested a review from a teamMay 19, 2024 19:14
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.
@handrewshandrews changed the title Clarify discriminator + oneOf/anyOf/allOf usage (3.0.4)Clarify discriminator "*Of" and "mapping" usage (3.0.4)May 21, 2024
ralfhandl
ralfhandl previously approved these changes May 23, 2024

@ralfhandlralfhandl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@mikekistlermikekistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One little nit, otherwise Looks good! 👍

Comment threadversions/3.0.4.md Outdated
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
@ralfhandl
ralfhandl merged commit 87d023a into OAI:v3.0.4-devMay 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)
@handrews
handrews deleted the disc-of-304 branch June 4, 2024 19:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarificationrequests to clarify, but not change, part of the specdiscriminator

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@handrews@ralfhandl@mikekistler