Skip to content

[jaxrs-cxf-cdi] multipart file upload should only present Attachment #21124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025

Conversation

selliera
Copy link
Contributor

Current template in case of a multipart file upload, will provide both Attachment and InputStream arguments.
The InputStream is not necessary, as it can be obtained from the Attachment object via getInputStream().
Moreover, when the API provides both, it becomes hard for implementers to know what to do: if using only the Attachment, should they close the input stream.
Providing only the Attachment, and using it to obtain the InputStream makes things easier to read/understand.

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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

The InputStream is not necessary, as it can be obtained from the
Attachment object via getInputStream().
@wing328
Copy link
Member

wing328 commented Apr 23, 2025

thanks for the pr

we will consider this a bug fix, and let's see if anyone needs the input stream for whatever reason.

@wing328 wing328 merged commit 338f7f2 into OpenAPITools:master Apr 23, 2025
32 checks passed
@wing328 wing328 added this to the 7.13.0 milestone Apr 23, 2025
@selliera
Copy link
Contributor Author

Thanks !
For the record, the change to apply to application code that was previously using the InputStream instead of the Attachment will be like changing:

try (inputstream) {
  // processing
}

with

try (attachment.getDataHandler().getInputStream()) {
  // processing
}

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.

2 participants