Skip to content

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

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.

Sign up for GitHub

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

Closed
mattpollock wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion modules/openapi-generator/src/main/resources/r/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,11 @@
{{/vendorExtensions.x-streaming}}
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)
}
Comment on lines 155 to +160
Copy link
Contributor Author

@mattpollock mattpollock Nov 20, 2024

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

@mattpollock mattpollock Nov 20, 2024

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.

} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
12 changes: 10 additions & 2 deletions samples/client/echo_api/r/R/auth_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,11 @@ AuthApi <- R6::R6Class(
TestAuthHttpBasic = function(data_file = NULL, ...) {
local_var_response <- self$TestAuthHttpBasicWithHttpInfo(data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -166,7 +170,11 @@ AuthApi <- R6::R6Class(
TestAuthHttpBearer = function(data_file = NULL, ...) {
local_var_response <- self$TestAuthHttpBearerWithHttpInfo(data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
60 changes: 50 additions & 10 deletions samples/client/echo_api/r/R/body_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,11 @@ BodyApi <- R6::R6Class(
TestBinaryGif = function(data_file = NULL, ...) {
local_var_response <- self$TestBinaryGifWithHttpInfo(data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -269,7 +273,11 @@ BodyApi <- R6::R6Class(
TestBodyApplicationOctetstreamBinary = function(body = NULL, data_file = NULL, ...) {
local_var_response <- self$TestBodyApplicationOctetstreamBinaryWithHttpInfo(body, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -362,7 +370,11 @@ BodyApi <- R6::R6Class(
TestBodyMultipartFormdataArrayOfBinary = function(files, data_file = NULL, ...) {
local_var_response <- self$TestBodyMultipartFormdataArrayOfBinaryWithHttpInfo(files, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -454,7 +466,11 @@ BodyApi <- R6::R6Class(
TestBodyMultipartFormdataSingleBinary = function(my_file = NULL, data_file = NULL, ...) {
local_var_response <- self$TestBodyMultipartFormdataSingleBinaryWithHttpInfo(my_file, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -542,7 +558,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyAllOfPet = function(pet = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyAllOfPetWithHttpInfo(pet, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -635,7 +655,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyFreeFormObjectResponseString = function(body = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyFreeFormObjectResponseStringWithHttpInfo(body, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -728,7 +752,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyPet = function(pet = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyPetWithHttpInfo(pet, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -821,7 +849,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyPetResponseString = function(pet = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyPetResponseStringWithHttpInfo(pet, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -914,7 +946,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyStringEnum = function(body = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyStringEnumWithHttpInfo(body, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -1007,7 +1043,11 @@ BodyApi <- R6::R6Class(
TestEchoBodyTagResponseString = function(tag = NULL, data_file = NULL, ...) {
local_var_response <- self$TestEchoBodyTagResponseStringWithHttpInfo(tag, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
18 changes: 15 additions & 3 deletions samples/client/echo_api/r/R/form_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,11 @@ FormApi <- R6::R6Class(
TestFormIntegerBooleanString = function(integer_form = NULL, boolean_form = NULL, string_form = NULL, data_file = NULL, ...) {
local_var_response <- self$TestFormIntegerBooleanStringWithHttpInfo(integer_form, boolean_form, string_form, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -191,7 +195,11 @@ FormApi <- R6::R6Class(
TestFormObjectMultipart = function(marker, data_file = NULL, ...) {
local_var_response <- self$TestFormObjectMultipartWithHttpInfo(marker, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down Expand Up @@ -288,7 +296,11 @@ FormApi <- R6::R6Class(
TestFormOneof = function(form1 = NULL, form2 = NULL, form3 = NULL, form4 = NULL, id = NULL, name = NULL, data_file = NULL, ...) {
local_var_response <- self$TestFormOneofWithHttpInfo(form1, form2, form3, form4, id, name, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
6 changes: 5 additions & 1 deletion samples/client/echo_api/r/R/header_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,11 @@ HeaderApi <- R6::R6Class(
TestHeaderIntegerBooleanStringEnums = function(integer_header = NULL, boolean_header = NULL, string_header = NULL, enum_nonref_string_header = NULL, enum_ref_string_header = NULL, data_file = NULL, ...) {
local_var_response <- self$TestHeaderIntegerBooleanStringEnumsWithHttpInfo(integer_header, boolean_header, string_header, enum_nonref_string_header, enum_ref_string_header, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
6 changes: 5 additions & 1 deletion samples/client/echo_api/r/R/path_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ PathApi <- R6::R6Class(
TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath = function(path_string, path_integer, enum_nonref_string_path, enum_ref_string_path, data_file = NULL, ...) {
local_var_response <- self$TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathWithHttpInfo(path_string, path_integer, enum_nonref_string_path, enum_ref_string_path, data_file = data_file, ...)
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)
}
} else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
local_var_response
} else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) {
Expand Down
Loading
Loading