Skip to content

Conversation

@ralfhandl-repo-access-token
Copy link

Merge relevant changes from main into dev.

handrews and others added 30 commits July 19, 2025 11:17
Add the Media Type Object to the Components Object,
and allow a Reference Object anywhere it is allowed.

To ensure that re-usable Objects can be documented clearly, add
a `description` field.
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
This adds support for all `multipart` media types that do not
have named parts, including support for streaming such media types.
Note that `multipart/mixed` defines the basic processing rules
for all `multipart` types, and implementations that encounter
unrecognized `multipart` subtypes are required to process them
as `multipart/mixed`.  Therefore support for `multipart/mixed`
addresses all other subtypes to some degree.

This builds on the recent support for sequential media types:

* `multipart/mixed` and similar meet the definition for
  a sequential media type, requiring it to be modeled as
  an array.  This does use an expansive definition of
  "repeating the same structure", where the structure is
  literally any content with a media type.
* As a sequential media type, it also supports `itemSchema`
* Adding a parallel `itemEncoding` is the obvious solution to
  `multipart/mixed` streams requiring an Encoding Object
* We have regularly received requests to support truly mixed
  `multipart/mixed` payloads, and previously claimed such support
  from 3.0.0 onwards, without actually supporting it.
  Adding `prefixEncoding` along with `itemEncoding` supports this
  use case with a clear parallel to `prefixItems`, which is the
  schema construct needed to support this case.
* There is no need for a `prefixSchema` field because the streaming
  use case requires a repetition of the same schema for each item.
  Therefore all mixed use cases can use `schema` and `prefixItems`
It's not an error if you have more encoding objects than instances.
Co-authored-by: Lorna Jane Mitchell <[email protected]>
Wow, I must have been having A Day™ when I wrote this before...
v3.2: Move a paragraph, unchanged, to make more sense in multipart encoding
Co-authored-by: Ralf Handl <[email protected]>
v3.2 Add data vs serialized example fields (3rd try)
v3.2: Explain Param and Header example serialization
v3.2: (Split and smaller!) Support ordered multipart including streaming
lornajane and others added 25 commits September 19, 2025 15:30
Official 3.1.2 release branch
Official 3.2.0 release branch
main: Fix broken links in 3.2.0.md
main: adjust reviewers in respec workflow
Change commit command to avoid failure if no changes.
Updated the GitHub Actions workflow to include fetch-depth and token in the checkout step, and commented out user configuration lines.
@ralfhandl ralfhandl closed this Oct 4, 2025
@ralfhandl ralfhandl deleted the dev-sync-with-main branch October 4, 2025 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants