openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[dart-dio] Fix json_serializable response for type:string format:binary

Open matthewnitschke-wk opened this issue 7 months ago • 1 comments

Summary

Using the dart-dio generator against a response of type:string, format:binary, would result in a MultipartFile return type. This causes the deserialize function to fail.

This PR takes inspiration from the built_value serialization method by treating response file types as Uint8List

Closes #20682

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] 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.
  • [x] 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)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. …ry response types

@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)

matthewnitschke-wk avatar Jun 04 '25 18:06 matthewnitschke-wk

@wing328 Ended up creating a specific test case for this to prevent effecting non-dart-dio generators: bin/configs/dart-dio-binary-response.yaml

Can you approve the workflow run so we can see if tests pass?

matthewnitschke-wk avatar Jun 10 '25 21:06 matthewnitschke-wk

@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)

Any thoughts?

matthewnitschke-wk avatar Jun 30 '25 14:06 matthewnitschke-wk

@matthewnitschke-wk thanks again for the PR

is it correct to say that you've tested this fix locally with your use cases and it's working as expected?

wing328 avatar Jun 30 '25 15:06 wing328

@matthewnitschke-wk thanks again for the PR

is it correct to say that you've tested this fix locally with your use cases and it's working as expected?

@wing328 Correct, I've validated that the specific combination of type:string + format:binary response works locally

matthewnitschke-wk avatar Jun 30 '25 20:06 matthewnitschke-wk

ok. let's give it a try

wing328 avatar Jul 01 '25 12:07 wing328

thanks again for the PR which has been merged

wing328 avatar Jul 01 '25 12:07 wing328