Skip to content

v3.2: Provide guidance for multiple contentType values - #4744

Merged
ralfhandl merged 2 commits into
OAI:v3.2-devfrom
handrews:multi-media
Jul 18, 2025
Merged

v3.2: Provide guidance for multiple contentType values#4744
ralfhandl merged 2 commits into
OAI:v3.2-devfrom
handrews:multi-media

Conversation

@handrews

@handrewshandrews commented Jun 21, 2025

Copy link
Copy Markdown
Member

We have always allowed multiple contentType values in the Encoding Object, but do not provide any guidance on how to determine which to use when performing the encoding. This adds such guidance.

This has become more relevant with multipart/mixed support, as the only way to define a set of parts where the order of the media types is not predictable (perhaps because the number of each media type is variable) is to use itemEncoding and put all of the media types in contentType.

An example of this usage can be found in PR #4746.

(also fix a copy-paste error that left a + at the beginning of a line)

  • no schema changes are needed for this pull request

We allow multiple `contentType` values in the Encoding Object,
but do not provide any guidance on how to determine which to use
when performing the encoding. This adds such guidance.
@handrewshandrews added this to the v3.2.0 milestone Jun 21, 2025
@handrews
handrews requested review from a team as code ownersJune 21, 2025 01:15
@handrewshandrews added the media and encoding Issues regarding media type support and how to encode data (outside of query/path params) label Jun 21, 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.

+1, minor nit

Comment threadsrc/oas.md Outdated
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
@lornajane
lornajane requested a review from ralfhandlJuly 17, 2025 16:15
@ralfhandl
ralfhandl merged commit 88aa65b into OAI:v3.2-devJul 18, 2025
2 checks passed
@handrews
handrews deleted the multi-media branch August 4, 2025 18:52
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

media and encodingIssues regarding media type support and how to encode data (outside of query/path params)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@handrews@philsturgeon@lornajane@ralfhandl