Skip to content

v3.1: "example" and "examples" cannot appear together #4917

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 6, 2025
Merged

v3.1: "example" and "examples" cannot appear together #4917

merged 1 commit into from
Sep 6, 2025

Conversation

@karenetheridge
Copy link
Member

This affects the places where examples are used: parameter, header, and media-type objects

for #4598 and #4776, ported from #4912.

  • schema changes are included in this pull request

@karenetheridge karenetheridge requested review from a team as code owners August 31, 2025 23:31
handrews
handrews previously approved these changes Aug 31, 2025
View reviewed changes
Copy link
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

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

Thanks! This is unrelated to the "overriding" thing, btw, which was about either of these fields vs the example field in the Schema Object.

@karenetheridge karenetheridge changed the title "example" and "examples" cannot appear together v3.1: "example" and "examples" cannot appear together Sep 1, 2025
ralfhandl
ralfhandl requested changes Sep 1, 2025
View reviewed changes
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.

Could you please add a "fail" test case that would pass without the additional lines?

@karenetheridge karenetheridge force-pushed the v3.1-example-examples-mutually-exclusive branch from b2c3ff5 to 5b54394 Compare September 4, 2025 23:41
@karenetheridge karenetheridge requested review from a team, handrews and ralfhandl September 4, 2025 23:43
ralfhandl
ralfhandl requested changes Sep 5, 2025
View reviewed changes
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.

Could you please use value in the 3.1 test case, so that the test case passes if the new schema lines are removed?

mikekistler
mikekistler previously approved these changes Sep 5, 2025
View reviewed changes
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.

+1 to @ralfhandl 's suggestion. the rest looks good.

Approving now so it can merge once Ralf's comment is addressed.

@karenetheridge
Copy link
Member Author

ahyes, dataValue is new :)

@karenetheridge
"example" and "examples" cannot appear together
f34083a 
This affects the places where examples are used: parameter, header, and media-type objects

for OAI#4598, ported from OAI#4912.
@karenetheridge karenetheridge force-pushed the v3.1-example-examples-mutually-exclusive branch from 5b54394 to f34083a Compare September 5, 2025 23:31
@ralfhandl ralfhandl requested review from a team and mikekistler September 6, 2025 13:16
@ralfhandl
Copy link
Contributor

Approving now so it can merge once Ralf's comment is addressed.

@mikekistler Unfortunately you have to reapprove.

@handrews handrews merged commit c33e5ba into OAI:v3.1-dev Sep 6, 2025
2 checks passed
@karenetheridge karenetheridge deleted the v3.1-example-examples-mutually-exclusive branch September 7, 2025 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ralfhandl ralfhandl ralfhandl approved these changes

@handrews handrews handrews approved these changes

@mikekistler mikekistler Awaiting requested review from mikekistler

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@karenetheridge @ralfhandl @handrews @mikekistler