Skip to content

[Ruby] Added Support for Binary Media Data Return#11254

Merged
wing328 merged 14 commits intoOpenAPITools:masterfrom
Bandwidth-Sandbox:ckoegel-ruby-binary
Mar 23, 2022
Merged

[Ruby] Added Support for Binary Media Data Return#11254
wing328 merged 14 commits intoOpenAPITools:masterfrom
Bandwidth-Sandbox:ckoegel-ruby-binary

Conversation

@ckoegel
Copy link
Copy Markdown
Contributor

@ckoegel ckoegel commented Jan 7, 2022

Currently, only data return types of String and File are supported, this PR allows for a Binary return type, which returns the raw binary data from a gotten file. This data can be written to a file, allowing users to have the option to receive raw binary data without needed to download a temporary file. This can be validated by setting debug_return_type to 'Binary' when making a get request, and then writing the data received to a file.

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.

@cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

@ckoegel ckoegel marked this pull request as ready for review January 13, 2022 21:32
@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 8, 2022

request.url url
request.params = query_params
download_file(request) if opts[:return_type] == 'File'
download_file(request) if opts[:return_type] == 'File' || 'Binary'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If I change this line to

download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'

the local tests pass. Can you give it a try?

@wing328 wing328 merged commit 2c4daea into OpenAPITools:master Mar 23, 2022
@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 27, 2022

I just ran more tests to confirm the return type won't be Binary so I've filed #11974 to add an option to return binary data.

@ckoegel ckoegel deleted the ckoegel-ruby-binary branch March 28, 2022 15:41
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