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-netcore] Fix incorrect FileParameter deserialization #11850

Conversation

NoTuxNoBux
Copy link
Contributor

@NoTuxNoBux NoTuxNoBux commented Mar 10, 2022

Fixes #10588.

OpenAPI responses with binary content have a method generated that returns a FileParameter with the csharp-netcore generator, but this type can't actually be deserialized properly when the call is made, resulting in an error. The type is simply a wrapper for a stream, so reading the stream and creating the FileParameter is sufficient to fix the problem.

Testing done is that we've tried this fix proposed in #10588 successfully and are using it in production with an OpenAPI that has the following 200 response definition for a GET request that downloads a file:

{
    "description": "The call was successful.",
    "content": {
        "image/png": {
            "schema": { "type": "string", "format": "binary" }
        }
    }
}

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.3.0), 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, @frankyjuang, @shibayan, @Blackclaws, @lucamazzanti

@NoTuxNoBux NoTuxNoBux force-pushed the csharp-netcore-fix-file-parameter-deserialization branch from ebe94f8 to ae78a4f Compare March 10, 2022 11:55
@NoTuxNoBux
Copy link
Contributor Author

Looks like CI failed with a temporary connection error, I'll force-push a new commit to retrigger it.

@wing328 wing328 added this to the 6.0.0 milestone Mar 11, 2022
@wing328 wing328 merged commit 795db0c into OpenAPITools:master Mar 11, 2022
@wing328
Copy link
Member

wing328 commented Mar 11, 2022

LGTM. Thanks for the fix.

@NoTuxNoBux NoTuxNoBux deleted the csharp-netcore-fix-file-parameter-deserialization branch March 11, 2022 07:57
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.

[BUG][csharp-netcore] Failed to deserialize FileParameter when using HttpClient.
2 participants