Skip to content

v3.2: Parameter and Header example updates - #4801

Merged
miqui merged 3 commits into
OAI:v3.2-devfrom
handrews:param-header-ex-3
Jul 26, 2025
Merged

v3.2: Parameter and Header example updates#4801
miqui merged 3 commits into
OAI:v3.2-devfrom
handrews:param-header-ex-3

Conversation

@handrews

@handrewshandrews commented Jul 18, 2025

Copy link
Copy Markdown
Member

Note: This replaces the other half of PR #4673 (the first half being replaced by PR #4800), and updates parameter and header examples for PRs #4800, #4799., and #4802.

This updates for both the new example fields and for examples with content

  • no schema changes are needed for this pull request

This updates for both the new example fields and for examples with `content`
@handrewshandrews added this to the v3.2.0 milestone Jul 18, 2025
@handrews
handrews requested review from a team as code ownersJuly 18, 2025 21:52
@handrewshandrews added examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization media and encoding Issues regarding media type support and how to encode data (outside of query/path params) example obj/keywords Issues with the Example Object or exampel(s) keywords labels Jul 18, 2025
@ralfhandl
ralfhandl requested a review from a teamJuly 19, 2025 14:43
miqui
miqui previously approved these changes Jul 19, 2025
@ralfhandl
ralfhandl requested a review from a teamJuly 19, 2025 15:08
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
@handrews

Copy link
Copy Markdown
MemberAuthor

@ralfhandl the email notification contained this:

In src/oas.md:

@@ -1183,11 +1273,14 @@ content:
schema:
type: string
example: $.a.b[1:1]
+examples:
examples and example can currently only be used with schema, not with content, see https://github.com/OAI/OpenAPI-Specification/blob/v3.2-dev/src/oas.md#fixed-fields-for-use-with-content.

This affects multiple examples :sad:

but I don't see it now... was this just because I had split this from PR #4802? (and accidentally posted them in the wrong order...)

Co-authored-by: Ralf Handl <ralf.handl@sap.com>
@handrews
handrews requested a review from a teamJuly 19, 2025 15:58
@ralfhandl

Copy link
Copy Markdown
Contributor

Yes, I got confused for a minute and lost sight of the target picture.

Comment threadsrc/oas.md Outdated
@miqui
miqui merged commit 75ac257 into OAI:v3.2-devJul 26, 2025
2 checks passed
@handrews
handrews deleted the param-header-ex-3 branch August 4, 2025 18:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

example obj/keywordsIssues with the Example Object or exampel(s) keywordsexamplesrequests for more or better examples in the specificationheadersmedia and encodingIssues regarding media type support and how to encode data (outside of query/path params)param serializationIssues related to parameter and/or header serialization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@handrews@ralfhandl@miqui