Skip to content

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

Merged
handrews merged 1 commit into
OAI:v3.1-devfrom
karenetheridge:v3.1-example-examples-mutually-exclusive
Sep 6, 2025
Merged

v3.1: "example" and "examples" cannot appear together#4917
handrews merged 1 commit into
OAI:v3.1-devfrom
karenetheridge:v3.1-example-examples-mutually-exclusive

Conversation

@karenetheridge

@karenetheridgekarenetheridge commented Aug 31, 2025

Copy link
Copy Markdown
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 ownersAugust 31, 2025 23:31
handrews
handrews previously approved these changes Aug 31, 2025
View reviewed changes

@handrewshandrews left a comment

Copy link
Copy Markdown
Member

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.

@karenetheridgekarenetheridge changed the title "example" and "examples" cannot appear togetherv3.1: "example" and "examples" cannot appear togetherSep 1, 2025
ralfhandl
ralfhandl requested changes Sep 1, 2025
View reviewed changes

@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.

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

@karenetheridge
karenetheridgeforce-pushed the v3.1-example-examples-mutually-exclusive branch from b2c3ff5 to 5b54394CompareSeptember 4, 2025 23:41
@karenetheridge
karenetheridge requested review from a team, handrews and ralfhandlSeptember 4, 2025 23:43
ralfhandl
ralfhandl requested changes Sep 5, 2025
View reviewed changes

@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.

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

Comment threadtests/schema/fail/example-examples.yaml Outdated
mikekistler
mikekistler previously approved these changes Sep 5, 2025
View reviewed changes

@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.

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

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

@karenetheridge

karenetheridge commented Sep 5, 2025

Copy link
Copy Markdown
MemberAuthor

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
karenetheridgeforce-pushed the v3.1-example-examples-mutually-exclusive branch from 5b54394 to f34083aCompareSeptember 5, 2025 23:31
@ralfhandl
ralfhandl requested review from a team and mikekistlerSeptember 6, 2025 13:16
@ralfhandl

ralfhandl commented Sep 6, 2025

Copy link
Copy Markdown
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-devSep 6, 2025
2 checks passed
@karenetheridge
karenetheridge deleted the v3.1-example-examples-mutually-exclusive branch September 7, 2025 01:45
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ralfhandlralfhandlralfhandl approved these changes
@handrewshandrewshandrews approved these changes
@mikekistlermikekistlerAwaiting 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