v3.2: Allow Parameter/Header examples w/content #4802
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Parameter and Header serialization is complex, particularly when using the `content` field to use a Media Type Object. In such scenarios, the serialization occurs in two steps: The first step is to serialize the data to the media type, which can be captured by the `examples` field of the Media Type Object. The second is the encoding/escaping of the media type document for use in a URI, HTTP header, or other location with its own rules. Sometimes the part needing illustration with an example is at one level, sometimes at another, and sometimes it is helpful to show both. For simplicity, the "data" examples are always treated as the overall input data, so they would be the same at both levels. This is also because it is not always possible to show each step, particularly when there are binary serializations. This allows showing either step (or both steps) with both data and serialization, depending on what makes sense for the use case.
handrews
added
param serialization
This was referenced Jul 18, 2025
handrews
changed the title
miqui
previously approved these changes
Jul 19, 2025
ralfhandl
requested changes
Jul 19, 2025
|
@ralfhandl good catch! There should be an award for catching things that aren't actually part of the diff, that's advance reviewing skills there! |
ralfhandl
requested changes
Jul 19, 2025
src/schemas/validation/schema.yaml
Outdated
| @@ -733,6 +733,9 @@ $defs: | |||
| type: boolean | |||
| $ref: '#/$defs/examples' | |||
| $ref: '#/$defs/specification-extensions' | |||
There was a problem hiding this comment.
This line seems to be implied by the second allOf entry.
There was a problem hiding this comment.
@ralfhandl thanks, fixed!
Let's only explain the validation requirements in one place. Also, header example fields were supposed to be moved rather than duplicatd but I missed the removal of the old ones.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: This replaces PR #4648, except for the examples which are in PR #4801.
Parameter and Header serialization is complex, particularly when using the
contentfield to use a Media Type Object.In such scenarios, the serialization occurs in two steps: The first step is to serialize the data to the media type, which can be captured by the
examplesfield of the Media Type Object.The second is the encoding/escaping of the media type document for use in a URI, HTTP header, or other location with its own rules.
Sometimes the part needing illustration with an example is at one level, sometimes at another, and sometimes it is helpful to show both.
For simplicity, the "data" examples are always treated as the overall input data, so they would be the same at both levels. This is also because it is not always possible to show each step, particularly when there are binary serializations. This allows showing either step (or both steps) with both data and serialization, depending on what makes sense for the use case.