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 non-impact on validation #3907

Merged
merged 1 commit into from
Jun 17, 2024

Conversation

handrews
Copy link
Member

@handrews handrews commented Jun 13, 2024

Be very explicit that discriminator MUST NOT change the validation outcome, and explain the implication for the "allOf" use case.

Be very explicit that discriminator MUST NOT change the validation
outcome, and explain the implication for the "allOf" use case.
@handrews handrews added discriminator clarification requests to clarify, but not change, part of the spec labels Jun 13, 2024
@handrews handrews added this to the v3.0.4 milestone Jun 13, 2024
@handrews handrews requested a review from a team June 13, 2024 19:24
@jam01
Copy link

jam01 commented Jun 13, 2024

Would you consider changing Schema Object # Properties

to go from

The OpenAPI Schema Object dialect is defined as requiring the OAS base vocabulary, in addition to the vocabularies as specified in the JSON Schema draft 2020-12 general purpose meta-schema.

to

The OpenAPI Schema Object dialect declares the OAS base vocabulary as optional, in addition to the vocabularies as specified in the JSON Schema draft 2020-12 general purpose meta-schema. When supported an implementation can optimize validation performance, but does not change the outcome as optional vocabularies do not directly impact validation.

Or something along those lines...?

@handrews
Copy link
Member Author

@jam01 I'll handle that in the fix to issue #3877 which is about dialects specifically.

@handrews
Copy link
Member Author

@jam01 although I probably won't go into that level of detail- more likely I will link to the JSON Schema documentation for $vocabulary.

versions/3.0.4.md Show resolved Hide resolved
versions/3.0.4.md Show resolved Hide resolved
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.

Looks good. 👍

@handrews handrews merged commit 1ca6697 into OAI:v3.0.4-dev Jun 17, 2024
1 check passed
@handrews handrews deleted the disc-val-304 branch June 17, 2024 18:32
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.

4 participants