Skip to content
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

[csharp][httpclient] Introduce FileParameter as an abstraction #9426

Merged
merged 6 commits into from May 21, 2021

Conversation

Blackclaws
Copy link
Contributor

This introduces a new class FileParameter as an abstraction to use in our ApiClients. It contains an automatic implicit conversion for existing stream parameters so its backwards compatible to existing code.

The reason for this is, that there are platforms that have file like parameters and we currently have no way to pass a filename into our api clients aside from FileStreams. However for Browser platforms there are no FileStreams there are IBrowserFiles that do not map. So we need another abstraction.

This could be further expanded to add content types to the files.

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.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.
    @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02)

@wing328
Copy link
Member

wing328 commented May 15, 2021

cc @lucamazzanti as well (new C# technical committee member)

Copy link
Contributor

@lucamazzanti lucamazzanti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had the same needs, and I must override the client locally to avoid to clone and customize the apiclient.mustache file. After that PR, i will revert my customization and keep using it vanilla 100%.

A really useful feature to support also uploads from FileStreams but with the need to override the filename during upload.

It seems good, just watch out the warning i think you left.

@wing328 wing328 added this to the 5.2.0 milestone May 21, 2021
@wing328 wing328 merged commit 2c4e79f into OpenAPITools:master May 21, 2021
premiumitsolution pushed a commit to premiumitsolution/openapi-generator that referenced this pull request May 26, 2021
…PITools#9426)

* Introduce FileParameter as an abstraction

* Update Samples

* Add new file to samples

* Fix hardcoded package name

* Fix hardcoded package name, import FileParameter in Model

* Remove unneccesary warning
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.

None yet

3 participants