Skip to content

Conversation

handrews
Copy link
Member

@handrews handrews commented Jul 12, 2025

@mikekistler questioned why we have this language in one of the other example PRs, and after spending some time with it I agree. This is a very simple change that will make the other example updates more clear. Also, the new example fields (on which @hudlow and I are pretty close to agreeing at this point, I think) further clarify how to use different examples.


Commit message:

Examples at different levels serve different purposes, and it is not clear what is meant by "overriding." Removing this will allow tools to determine the most appropriate example(s) to show in a given context.

  • no schema changes are needed for this pull request

Examples at different levels serve different purposes, and it is
not clear what is meant by "overriding."  Removing this will
allow tools to determine the most appropriate example(s) to show
in a given context.
@handrews handrews added this to the v3.2.0 milestone Jul 12, 2025
@handrews handrews added the example obj/keywords Issues with the Example Object or exampel(s) keywords label Jul 12, 2025
@handrews handrews requested review from a team as code owners July 12, 2025 19:38
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! 👍

@ralfhandl ralfhandl merged commit 12a8939 into OAI:v3.2-dev Jul 13, 2025
2 checks passed
@handrews handrews deleted the no-override branch August 4, 2025 18:52
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#4578 and OAI#4776.
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#4578 and OAI#4776.
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.
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

example obj/keywords Issues with the Example Object or exampel(s) keywords

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants