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.

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

[R][Client] Allow api responses to be NULL or invalid JSON and fix file_params for file upload #18108

Closed
wants to merge 4 commits into from
Closed

[R][Client] Allow api responses to be NULL or invalid JSON and fix file_params for file upload #18108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00a38c8
allow deserialization of valid responses not following the JSON forma…
joXemMx Mar 14, 2024
d78cf8f
fix file_params using only single bracket
joXemMx Mar 14, 2024
13e6972
allow deserialization of NULL responses by turning them into NULL string
joXemMx Mar 14, 2024
2930654
update samples
joXemMx Mar 14, 2024
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
3 changes: 3 additions & 0 deletions modules/openapi-generator/src/main/resources/r/ApiResponse.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ ApiResponse <- R6::R6Class(
#' @param to_encoding The target encoding of the return value.
#' @export
response_as_text = function(from_encoding = "", to_encoding = "UTF-8") {
if (is.null(self$response)) {
self$response <- charToRaw(jsonlite::toJSON("NULL"))
}
text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding)
if (is.na(text_response)) {
warning("The response is binary and will not be converted to text.")
Expand Down
2 changes: 1 addition & 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 @@ -515,7 +515,7 @@
file_params["{{baseName}}"] <- httr::upload_file(`{{paramName}}`)
{{/isHttr2}}
{{#isHttr2}}
file_params["{{baseName}}"] <- curl::form_file(`{{paramName}}`)
file_params[["{{baseName}}"]] <- curl::form_file(`{{paramName}}`)
{{/isHttr2}}
{{/isFile}}
{{/formParams}}
Expand Down
6 changes: 5 additions & 1 deletion modules/openapi-generator/src/main/resources/r/api_client.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type
Expand Down
6 changes: 5 additions & 1 deletion modules/openapi-generator/src/main/resources/r/libraries/httr2/api_client.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type.
Expand Down
6 changes: 5 additions & 1 deletion samples/client/echo_api/r/R/api_client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type
Expand Down
3 changes: 3 additions & 0 deletions samples/client/echo_api/r/R/api_response.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ ApiResponse <- R6::R6Class(
#' @param to_encoding The target encoding of the return value.
#' @export
response_as_text = function(from_encoding = "", to_encoding = "UTF-8") {
if (is.null(self$response)) {
self$response <- charToRaw(jsonlite::toJSON("NULL"))
}
text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding)
if (is.na(text_response)) {
warning("The response is binary and will not be converted to text.")
Expand Down
6 changes: 5 additions & 1 deletion samples/client/petstore/R-httr2-wrapper/R/api_client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type.
Expand Down
3 changes: 3 additions & 0 deletions samples/client/petstore/R-httr2-wrapper/R/api_response.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ ApiResponse <- R6::R6Class(
#' @param to_encoding The target encoding of the return value.
#' @export
response_as_text = function(from_encoding = "", to_encoding = "UTF-8") {
if (is.null(self$response)) {
self$response <- charToRaw(jsonlite::toJSON("NULL"))
}
text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding)
if (is.na(text_response)) {
warning("The response is binary and will not be converted to text.")
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/R-httr2-wrapper/R/pet_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1807,7 +1807,7 @@ PetApi <- R6::R6Class(


form_params["additionalMetadata"] <- `additional_metadata`
file_params["file"] <- curl::form_file(`file`)
file_params[["file"]] <- curl::form_file(`file`)
local_var_url_path <- "/pet/{petId}/uploadImage"
if (!missing(`pet_id`)) {
local_var_url_path <- gsub("\\{petId\\}", URLencode(as.character(`pet_id`), reserved = TRUE), local_var_url_path)
Expand Down
6 changes: 5 additions & 1 deletion samples/client/petstore/R-httr2/R/api_client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type.
Expand Down
3 changes: 3 additions & 0 deletions samples/client/petstore/R-httr2/R/api_response.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ ApiResponse <- R6::R6Class(
#' @param to_encoding The target encoding of the return value.
#' @export
response_as_text = function(from_encoding = "", to_encoding = "UTF-8") {
if (is.null(self$response)) {
self$response <- charToRaw(jsonlite::toJSON("NULL"))
}
text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding)
if (is.na(text_response)) {
warning("The response is binary and will not be converted to text.")
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/R-httr2/R/pet_api.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1807,7 +1807,7 @@ PetApi <- R6::R6Class(


form_params["additionalMetadata"] <- `additional_metadata`
file_params["file"] <- curl::form_file(`file`)
file_params[["file"]] <- curl::form_file(`file`)
local_var_url_path <- "/pet/{petId}/uploadImage"
if (!missing(`pet_id`)) {
local_var_url_path <- gsub("\\{petId\\}", URLencode(as.character(`pet_id`), reserved = TRUE), local_var_url_path)
Expand Down
6 changes: 5 additions & 1 deletion samples/client/petstore/R/R/api_client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,11 @@ ApiClient <- R6::R6Class(
#' @return Deserialized object.
#' @export
deserialize = function(raw_response, return_type, pkg_env) {
resp_obj <- jsonlite::fromJSON(raw_response)
if (jsonlite::validate(raw_response)) {
resp_obj <- jsonlite::fromJSON(raw_response)
} else {
resp_obj <- raw_response
}
self$deserializeObj(resp_obj, return_type, pkg_env)
},
#' Deserialize the response from jsonlite object based on the given type
Expand Down
3 changes: 3 additions & 0 deletions samples/client/petstore/R/R/api_response.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ ApiResponse <- R6::R6Class(
#' @param to_encoding The target encoding of the return value.
#' @export
response_as_text = function(from_encoding = "", to_encoding = "UTF-8") {
if (is.null(self$response)) {
self$response <- charToRaw(jsonlite::toJSON("NULL"))
}
text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding)
if (is.na(text_response)) {
warning("The response is binary and will not be converted to text.")
Expand Down
Loading