fix(python-fastapi): map binary response type file to bytes#24285
Merged
wing328 merged 1 commit intoJul 14, 2026
Conversation
Fixes invalid `-> file` / `"model": file` for octet-stream responses (OpenAPITools#20775).
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
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.
Description
Fixes invalid
-> file/"model": filefor binary (application/octet-stream+format: binary) response bodies in python-fastapi (#20775).Python 3 has no built-in
filetype, so generated stubs raisedNameErroron import and broke IDE typing. This change maps OASfile/binaryto built-inbytesinPythonFastAPIServerCodegenonly (minimal scope). Multipart upload fields still use FastAPIUploadFilevia the existing form-param override (#23793).What changed
typeMapping.put("file", "bytes")andtypeMapping.put("binary", "bytes")inPythonFastAPIServerCodegenmodules/openapi-generator/src/test/resources/3_0/issue_20775.yaml(200/206 + optionalRange)PythonFastapiCodegenTest/PythonFastAPIServerCodegenTestassert-> bytes/"model": bytesand absence of barefileVerification
No
samples/diff: current python-fastapi petstore has no binary response endpoints (only multipart upload). Coverage is viaissue_20775.yamlunit generation.Related: #20775, #4372
PR checklist
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.
Summary by cubic
Maps binary response bodies to
bytesinpython-fastapiserver generation to replace the invalid Pythonfiletype. This prevents import errors and fixes typing forapplication/octet-streamresponses.fileandbinarytobytesinPythonFastAPIServerCodegen.UploadFile(unchanged).issue_20775.yamland tests asserting-> bytesand nofile.file#4372.Written for commit 24dd78a. Summary will update on new commits.