OpenAPITools / OpenAPITools/openapi-generator
[BUG] [python] Chunked (streamed) responses are not fully read before fed into pydantic deserialization
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
We have an api endpoint that uses Django's StreamingHttpResponse which, to my understanding, sends the response chunked. The generated python client only reads the first chunk (in this case "[", the opening of a list to follow) and fails when trying to deserialize that in to a pydantic object.
openapi-generator version
7.10.0
it worked in 4.3.1
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file, test, or reproduction specification is named. Start by tracing the generated Python client's response-reading and Pydantic deserialization path, then compare behavior with version 4.3.1 using a Django StreamingHttpResponse. Done means the complete chunked response is read before deserialization and the resulting list is handled successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100