Skip to content

v3.2: "example" and "examples" cannot appear together - #4912

Merged
ralfhandl merged 1 commit into
OAI:v3.2-devfrom
karenetheridge:ether/v3.2-example-examples-mutually-exclusive
Sep 5, 2025
Merged

v3.2: "example" and "examples" cannot appear together#4912
ralfhandl merged 1 commit into
OAI:v3.2-devfrom
karenetheridge:ether/v3.2-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.

  • schema changes are included in this pull request

@karenetheridge
karenetheridge requested review from a team as code ownersAugust 31, 2025 23:13
@karenetheridgekarenetheridge added the Schema changes related to the schema(s) label Aug 31, 2025
@karenetheridgekarenetheridge added this to the v3.2.0 milestone Aug 31, 2025
handrews
handrews previously approved these changes Aug 31, 2025

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

Weird- this is handled correctly in the 3.0 schema, but was apparently dropped in 3.1? Which was definitely an error.

@karenetheridge
karenetheridgeforce-pushed the ether/v3.2-example-examples-mutually-exclusive branch from 997d12a to 5a6eb77CompareAugust 31, 2025 23:21
@karenetheridge

Copy link
Copy Markdown
MemberAuthor

This should probably be backported to 3.1.2 then?

@handrews

This comment was marked as off-topic.

karenetheridge added a commit to karenetheridge/OpenAPI-Specification that referenced this pull request Aug 31, 2025
This affects the places where examples are used: parameter, header, and media-type objects
for OAI#4598 and OAI#4776, ported from OAI#4912.
@karenetheridgekarenetheridge changed the title "example" and "examples" cannot appear togetherv3.2: "example" and "examples" cannot appear togetherSep 1, 2025

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

This affects the places where examples are used: parameter, header, and media-type objects
for OAI#4598.
@karenetheridge
karenetheridgeforce-pushed the ether/v3.2-example-examples-mutually-exclusive branch from 5a6eb77 to dc5dad6CompareSeptember 4, 2025 23:38
karenetheridge added a commit to karenetheridge/OpenAPI-Specification that referenced this pull request Sep 4, 2025
This affects the places where examples are used: parameter, header, and media-type objects
for OAI#4598, ported from OAI#4912.
@karenetheridge
karenetheridge requested review from a team and ralfhandl and removed request for ralfhandlSeptember 4, 2025 23:43
@ralfhandl
ralfhandl requested review from a team and handrewsSeptember 5, 2025 07:11

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

Looks good. 👍

@ralfhandl
ralfhandl merged commit 2933fe9 into OAI:v3.2-devSep 5, 2025
2 checks passed
@karenetheridge
karenetheridge deleted the ether/v3.2-example-examples-mutually-exclusive branch September 5, 2025 23:30
karenetheridge added a commit to karenetheridge/OpenAPI-Specification that referenced this pull request Sep 5, 2025
This affects the places where examples are used: parameter, header, and media-type objects
for OAI#4598, ported from OAI#4912.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Schemachanges related to the schema(s)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@karenetheridge@handrews@ralfhandl@mikekistler