Skip to content

fix(core): normalize OAS 3.1 content media schemas#23851

Draft
erichasinternet wants to merge 1 commit into
OpenAPITools:masterfrom
erichasinternet:fix/binary-content-media-type
Draft

fix(core): normalize OAS 3.1 content media schemas#23851
erichasinternet wants to merge 1 commit into
OpenAPITools:masterfrom
erichasinternet:fix/binary-content-media-type

Conversation

@erichasinternet
Copy link
Copy Markdown

@erichasinternet erichasinternet commented May 22, 2026

Fixes #23095
Refs #13083, #9083

OpenAPI 3.1 allows a binary string payload to be represented with JSON Schema content keywords, for example:

type: string
contentMediaType: application/octet-stream

OpenAPI Generator already has binary/file handling around the normalized type: string + format: binary shape. This PR normalizes that OAS 3.1 form before schema processing treats type-less content schemas as empty schemas.

With this change, OAS 3.1 contentMediaType: application/octet-stream schemas normalize to type: string and format: binary. It also covers nullable type: [string, "null"] and type-less content schemas. Schemas with contentEncoding, non-binary media types, existing explicit formats, refs, or non-string types are left unchanged.

I added focused coverage for the normalizer and multipart form parameter handling using an OAS 3.1 fixture, and ran the checklist build/sample/docs commands locally.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@erichasinternet erichasinternet changed the title fix(core): recognize OAS 3.1 contentMediaType for binary classification fix(core): normalize OAS 3.1 content media schemas May 23, 2026
@erichasinternet erichasinternet force-pushed the fix/binary-content-media-type branch from 24df88b to aa11ace Compare May 23, 2026 05:00
@erichasinternet erichasinternet force-pushed the fix/binary-content-media-type branch from aa11ace to 5b61524 Compare May 23, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ] Add support for contentMediaType/contentMediaEncoding to align with OAS 3.1

1 participant