Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
May 23, 2024

Conversation

handrews
Copy link
Member

@handrews handrews commented May 19, 2024

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.
@handrews handrews added discriminator clarification requests to clarify, but not change, part of the spec labels May 19, 2024
@handrews handrews added this to the v3.0.4 milestone May 19, 2024
@handrews handrews requested a review from a team May 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.
@handrews handrews 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
Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

Very nice!

Copy link
Contributor

@mikekistler mikekistler left a comment

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! 👍

versions/3.0.4.md Outdated Show resolved Hide resolved
@ralfhandl ralfhandl merged commit 87d023a into OAI:v3.0.4-dev May 23, 2024
1 check passed
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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec discriminator
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants