optionally skip parsing responses to R6 objects

Author: mattpollock

modules/openapi-generator/src/main/resources/r/api.mustache

@@ -142,10 +142,11 @@
     #' @param data_file (optional) name of the data file to save the result
     {{/returnType}}
     #' @param ... Other optional arguments
+    #' @param parse Logical. If \code{TRUE} then the response will be parsed to a generated type. If \code{FALSE} the response will be returned as unparsed text.
     #'
     #' @return {{{returnType}}}{{^returnType}}void{{/returnType}}
-    {{{operationId}}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}} = {{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#vendorExtensions.x-streaming}}stream_callback = NULL, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = NULL, {{/returnType}}...) {
-      local_var_response <- self${{{operationId}}}{{WithHttpInfo}}({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions.x-streaming}}stream_callback = stream_callback, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = data_file, {{/returnType}}...)
+    {{{operationId}}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}} = {{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#vendorExtensions.x-streaming}}stream_callback = NULL, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = NULL, {{/returnType}}..., parse = TRUE) {
+      local_var_response <- self${{{operationId}}}{{WithHttpInfo}}({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions.x-streaming}}stream_callback = stream_callback, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = data_file, {{/returnType}}..., parse = parse)
       {{#vendorExtensions.x-streaming}}
       if (typeof(stream_callback) == "closure") { # return void if streaming is enabled
         return(invisible(NULL))
@@ -181,7 +182,7 @@
     #' @param ... Other optional arguments
     #'
     #' @return API response ({{{returnType}}}{{^returnType}}void{{/returnType}}) with additional information such as HTTP status code, headers
-    {{{operationId}}}{{WithHttpInfo}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}} = {{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#vendorExtensions.x-streaming}}stream_callback = NULL, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = NULL, {{/returnType}}...) {
+    {{{operationId}}}{{WithHttpInfo}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}} = {{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#vendorExtensions.x-streaming}}stream_callback = NULL, {{/vendorExtensions.x-streaming}}{{#returnType}}data_file = NULL, parse = TRUE, {{/returnType}}...) {
       args <- list(...)
       query_params <- list()
       header_params <- c()
@@ -569,6 +570,11 @@
           self$api_client$WriteFile(local_var_resp, data_file)
         }
 
+        if (!parse) {
+          local_var_resp$content <- local_var_resp$response_as_text()
+          return(local_var_resp)
+        }
+
         deserialized_resp_obj <- tryCatch(
           self$api_client$DeserializeResponse(local_var_resp, "{{returnType}}"),
           error = function(e) {

samples/client/echo_api/r/R/auth_api.R

@@ -73,10 +73,11 @@ AuthApi <- R6::R6Class(
     #'
     #' @param data_file (optional) name of the data file to save the result
     #' @param ... Other optional arguments
+    #' @param parse Logical. If \code{TRUE} then the response will be parsed to a generated type. If \code{FALSE} the response will be returned as unparsed text.
     #'
     #' @return character
-    TestAuthHttpBasic = function(data_file = NULL, ...) {
-      local_var_response <- self$TestAuthHttpBasicWithHttpInfo(data_file = data_file, ...)
+    TestAuthHttpBasic = function(data_file = NULL, ..., parse = TRUE) {
+      local_var_response <- self$TestAuthHttpBasicWithHttpInfo(data_file = data_file, ..., parse = parse)
       if (local_var_response$status_code >= 200 && local_var_response$status_code <= 299) {
         return(local_var_response$content)
       } else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
@@ -95,7 +96,7 @@ AuthApi <- R6::R6Class(
     #' @param ... Other optional arguments
     #'
     #' @return API response (character) with additional information such as HTTP status code, headers
-    TestAuthHttpBasicWithHttpInfo = function(data_file = NULL, ...) {
+    TestAuthHttpBasicWithHttpInfo = function(data_file = NULL, parse = TRUE, ...) {
       args <- list(...)
       query_params <- list()
       header_params <- c()
@@ -136,6 +137,11 @@ AuthApi <- R6::R6Class(
           self$api_client$WriteFile(local_var_resp, data_file)
         }
 
+        if (!parse) {
+          local_var_resp$content <- local_var_resp$response_as_text()
+          return(local_var_resp)
+        }
+
         deserialized_resp_obj <- tryCatch(
           self$api_client$DeserializeResponse(local_var_resp, "character"),
           error = function(e) {
@@ -164,10 +170,11 @@ AuthApi <- R6::R6Class(
     #'
     #' @param data_file (optional) name of the data file to save the result
     #' @param ... Other optional arguments
+    #' @param parse Logical. If \code{TRUE} then the response will be parsed to a generated type. If \code{FALSE} the response will be returned as unparsed text.
     #'
     #' @return character
-    TestAuthHttpBearer = function(data_file = NULL, ...) {
-      local_var_response <- self$TestAuthHttpBearerWithHttpInfo(data_file = data_file, ...)
+    TestAuthHttpBearer = function(data_file = NULL, ..., parse = TRUE) {
+      local_var_response <- self$TestAuthHttpBearerWithHttpInfo(data_file = data_file, ..., parse = parse)
       if (local_var_response$status_code >= 200 && local_var_response$status_code <= 299) {
         return(local_var_response$content)
       } else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) {
@@ -186,7 +193,7 @@ AuthApi <- R6::R6Class(
     #' @param ... Other optional arguments
     #'
     #' @return API response (character) with additional information such as HTTP status code, headers
-    TestAuthHttpBearerWithHttpInfo = function(data_file = NULL, ...) {
+    TestAuthHttpBearerWithHttpInfo = function(data_file = NULL, parse = TRUE, ...) {
       args <- list(...)
       query_params <- list()
       header_params <- c()
@@ -227,6 +234,11 @@ AuthApi <- R6::R6Class(
           self$api_client$WriteFile(local_var_resp, data_file)
         }
 
+        if (!parse) {
+          local_var_resp$content <- local_var_resp$response_as_text()
+          return(local_var_resp)
+        }
+
         deserialized_resp_obj <- tryCatch(
           self$api_client$DeserializeResponse(local_var_resp, "character"),
           error = function(e) {