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

[R] return API response when content is raw (not coercible to text) #20142

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mattpollock
Copy link
Contributor

This is a new PR for a breaking change removed from #20131.

@Ramanth, @saigiridhar21, @wing328

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.

Comment on lines 155 to +160
if (local_var_response$status_code >= 200 && local_var_response$status_code <= 299) {
local_var_response$content
if (is.raw(local_var_response$content)) {
return(local_var_response)
} else {
return(local_var_response$content)
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@wing328 feel free to keep or discard this change. As requested I pulled this out of #20131. If declined, the result will be that when an endpoint that returns binary data (e.g., a gzipped directory) that cannot be coerced to text, the return value will be a raw vector. If accepted, the return value in this case will be an instance of ApiResponse, which is what gets returned if there are error codes too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another alternative would be to return(invisible(local_var_response$content)) so that the raw vector, though returned, will not be printed in the event that it is not captured to a variable. This may be a better option since it seems likely that these sorts of endpoints will be invoked without assigning the response to a variable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant