diff --git a/modules/openapi-generator/src/main/resources/r/api_client.mustache b/modules/openapi-generator/src/main/resources/r/api_client.mustache index 9a2aa57c819..d5f220b9c0d 100644 --- a/modules/openapi-generator/src/main/resources/r/api_client.mustache +++ b/modules/openapi-generator/src/main/resources/r/api_client.mustache @@ -1,5 +1,4 @@ {{>partial_header}} - #' ApiClient Class #' #' Generic API client for OpenAPI client library builds. @@ -18,11 +17,11 @@ #' @format An \code{R6Class} generator object #' @field base_path Base url #' @field user_agent Default user agent -#' @field default_headers +#' @field default_headers Default headers #' @field username Username for HTTP basic authentication #' @field password Password for HTTP basic authentication -#' @field api_keys -#' @field access_token +#' @field api_keys API keys +#' @field access_token Access token #' @field timeout Default timeout in seconds #' @field retry_status_codes vector of status codes to retry #' @field max_retry_attempts maximum number of retries for the status codes @@ -54,7 +53,22 @@ ApiClient <- R6::R6Class( retry_status_codes = NULL, # Maximum number of retry attempts for the retry status codes max_retry_attempts = NULL, - # constructor + #' Initialize a new ApiClient. + #' + #' @description + #' Initialize a new ApiClient. + #' + #' @param base_path Base path. + #' @param user_agent User agent. + #' @param default_headers Default headers. + #' @param username User name. + #' @param password Password. + #' @param api_keys API keys. + #' @param access_token Access token. + #' @param timeout Timeout. + #' @param retry_status_codes Status codes for retry. + #' @param max_retry_attempts Maxmium number of retry. + #' @export initialize = function(base_path=NULL, user_agent=NULL, default_headers=NULL, username=NULL, password=NULL, api_keys=NULL, access_token=NULL, timeout=NULL, @@ -101,7 +115,19 @@ ApiClient <- R6::R6Class( self$max_retry_attempts <- max_retry_attempts } }, - + #' Prepare to make an API call with the retry logic. + #' + #' @description + #' Prepare to make an API call with the retry logic. + #' + #' @param url URL. + #' @param method HTTP method. + #' @param query_params The query parameters. + #' @param header_params The header parameters. + #' @param body The HTTP request body. + #' @param ... Other optional arguments. + #' @return HTTP response + #' @export CallApi = function(url, method, query_params, header_params, body, ...) { resp <- self$Execute(url, method, query_params, header_params, body, ...) @@ -126,7 +152,19 @@ ApiClient <- R6::R6Class( resp }, - + #' Make an API call + #' + #' @description + #' Make an API call + #' + #' @param url URL. + #' @param method HTTP method. + #' @param query_params The query parameters. + #' @param header_params The header parameters. + #' @param body The HTTP request body. + #' @param ... Other optional arguments. + #' @return HTTP response + #' @export Execute = function(url, method, query_params, header_params, body, ...) { headers <- httr::add_headers(c(header_params, self$default_headers)) @@ -158,18 +196,33 @@ ApiClient <- R6::R6Class( {{/useRlangExceptionHandling}} } }, - - # Deserialize the content of api response to the given type. + #' Deserialize the content of api response to the given type. + #' + #' @description + #' Deserialize the content of api response to the given type. + #' + #' @param resp Response object. + #' @param return_type R return type. + #' @param pkg_env Package environment. + #' @return Deserialized object. + #' @export deserialize = function(resp, return_type, pkg_env) { resp_obj <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8")) self$deserializeObj(resp_obj, return_type, pkg_env) }, - - # Deserialize the response from jsonlite object based on the given type - # by handling complex and nested types by iterating recursively - # Example return_types will be like "array[integer]", "map(Pet)", "array[map(Tag)]", etc., - + #' Deserialize the response from jsonlite object based on the given type + #' + #' @description + #' Deserialize the response from jsonlite object based on the given type + #' by handling complex and nested types by iterating recursively + #' Example return_types will be like "array[integer]", "map(Pet)", "array[map(Tag)]", etc., + #' + #' @param obj Response object. + #' @param return_type R return type. + #' @param pkg_env Package environment. + #' @return Deserialized object. + #' @export deserializeObj = function(obj, return_type, pkg_env) { return_obj <- NULL primitive_types <- c("character", "numeric", "integer", "logical", "complex") diff --git a/modules/openapi-generator/src/main/resources/r/modelAnyOf.mustache b/modules/openapi-generator/src/main/resources/r/modelAnyOf.mustache index 62496d246da..5b0e047fbaf 100644 --- a/modules/openapi-generator/src/main/resources/r/modelAnyOf.mustache +++ b/modules/openapi-generator/src/main/resources/r/modelAnyOf.mustache @@ -24,7 +24,6 @@ #' #' @param instance an instance of the object defined in the anyOf schemas: {{#anyOf}}"{{{.}}}"{{^-last}}, {{/-last}}{{/anyOf}} #' @export - #' @md initialize = function(instance = NULL) { if (is.null(instance)) { # do nothing @@ -43,7 +42,6 @@ #' @param input The input JSON. #' @return An instance of {{{classname}}}. #' @export - #' @md fromJSON = function(input) { error_messages <- list() @@ -73,7 +71,6 @@ #' #' @return JSON string reprenation of the {{{classname}}}. #' @export - #' @md toJSON = function() { if (!is.null(self$actual_instance)) { self$actual_instance$toJSONString() @@ -89,7 +86,6 @@ #' #' @param input The input JSON. #' @export - #' @md validateJSON = function(input) { # backup current values actual_instance_bak <- self$actual_instance diff --git a/modules/openapi-generator/src/main/resources/r/modelOneOf.mustache b/modules/openapi-generator/src/main/resources/r/modelOneOf.mustache index 2b00fdcc929..2e67fd5e68b 100644 --- a/modules/openapi-generator/src/main/resources/r/modelOneOf.mustache +++ b/modules/openapi-generator/src/main/resources/r/modelOneOf.mustache @@ -24,7 +24,6 @@ #' #' @param instance an instance of the object defined in the oneOf schemas: {{#oneOf}}"{{{.}}}"{{^-last}}, {{/-last}}{{/oneOf}} #' @export - #' @md initialize = function(instance = NULL) { if (is.null(instance)) { # do nothing @@ -43,7 +42,6 @@ #' @param input The input JSON. #' @return An instance of {{{classname}}}. #' @export - #' @md fromJSON = function(input) { matched <- 0 # match counter matched_schemas <- list() #names of matched schemas @@ -88,7 +86,6 @@ #' #' @return JSON string reprenation of the {{{classname}}}. #' @export - #' @md toJSON = function() { if (!is.null(self$actual_instance)) { self$actual_instance$toJSONString() @@ -104,7 +101,6 @@ #' #' @param input The input JSON. #' @export - #' @md validateJSON = function(input) { # backup current values actual_instance_bak <- self$actual_instance diff --git a/samples/client/petstore/R/R/any_of_pig.R b/samples/client/petstore/R/R/any_of_pig.R index 1819af2d4d7..23c24102381 100644 --- a/samples/client/petstore/R/R/any_of_pig.R +++ b/samples/client/petstore/R/R/any_of_pig.R @@ -32,7 +32,6 @@ AnyOfPig <- R6::R6Class( #' #' @param instance an instance of the object defined in the anyOf schemas: "BasquePig", "DanishPig" #' @export - #' @md initialize = function(instance = NULL) { if (is.null(instance)) { # do nothing @@ -54,7 +53,6 @@ AnyOfPig <- R6::R6Class( #' @param input The input JSON. #' @return An instance of AnyOfPig. #' @export - #' @md fromJSON = function(input) { error_messages <- list() @@ -96,7 +94,6 @@ AnyOfPig <- R6::R6Class( #' #' @return JSON string reprenation of the AnyOfPig. #' @export - #' @md toJSON = function() { if (!is.null(self$actual_instance)) { self$actual_instance$toJSONString() @@ -112,7 +109,6 @@ AnyOfPig <- R6::R6Class( #' #' @param input The input JSON. #' @export - #' @md validateJSON = function(input) { # backup current values actual_instance_bak <- self$actual_instance diff --git a/samples/client/petstore/R/R/api_client.R b/samples/client/petstore/R/R/api_client.R index f18d3bfc88a..70912dd4de9 100644 --- a/samples/client/petstore/R/R/api_client.R +++ b/samples/client/petstore/R/R/api_client.R @@ -6,7 +6,6 @@ #' Generated by: https://openapi-generator.tech #' - #' ApiClient Class #' #' Generic API client for OpenAPI client library builds. @@ -25,11 +24,11 @@ #' @format An \code{R6Class} generator object #' @field base_path Base url #' @field user_agent Default user agent -#' @field default_headers +#' @field default_headers Default headers #' @field username Username for HTTP basic authentication #' @field password Password for HTTP basic authentication -#' @field api_keys -#' @field access_token +#' @field api_keys API keys +#' @field access_token Access token #' @field timeout Default timeout in seconds #' @field retry_status_codes vector of status codes to retry #' @field max_retry_attempts maximum number of retries for the status codes @@ -59,7 +58,22 @@ ApiClient <- R6::R6Class( retry_status_codes = NULL, # Maximum number of retry attempts for the retry status codes max_retry_attempts = NULL, - # constructor + #' Initialize a new ApiClient. + #' + #' @description + #' Initialize a new ApiClient. + #' + #' @param base_path Base path. + #' @param user_agent User agent. + #' @param default_headers Default headers. + #' @param username User name. + #' @param password Password. + #' @param api_keys API keys. + #' @param access_token Access token. + #' @param timeout Timeout. + #' @param retry_status_codes Status codes for retry. + #' @param max_retry_attempts Maxmium number of retry. + #' @export initialize = function(base_path=NULL, user_agent=NULL, default_headers=NULL, username=NULL, password=NULL, api_keys=NULL, access_token=NULL, timeout=NULL, @@ -106,7 +120,19 @@ ApiClient <- R6::R6Class( self$max_retry_attempts <- max_retry_attempts } }, - + #' Prepare to make an API call with the retry logic. + #' + #' @description + #' Prepare to make an API call with the retry logic. + #' + #' @param url URL. + #' @param method HTTP method. + #' @param query_params The query parameters. + #' @param header_params The header parameters. + #' @param body The HTTP request body. + #' @param ... Other optional arguments. + #' @return HTTP response + #' @export CallApi = function(url, method, query_params, header_params, body, ...) { resp <- self$Execute(url, method, query_params, header_params, body, ...) @@ -131,7 +157,19 @@ ApiClient <- R6::R6Class( resp }, - + #' Make an API call + #' + #' @description + #' Make an API call + #' + #' @param url URL. + #' @param method HTTP method. + #' @param query_params The query parameters. + #' @param header_params The header parameters. + #' @param body The HTTP request body. + #' @param ... Other optional arguments. + #' @return HTTP response + #' @export Execute = function(url, method, query_params, header_params, body, ...) { headers <- httr::add_headers(c(header_params, self$default_headers)) @@ -157,18 +195,33 @@ ApiClient <- R6::R6Class( rlang::abort(message = err_msg, .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = err_msg)) } }, - - # Deserialize the content of api response to the given type. + #' Deserialize the content of api response to the given type. + #' + #' @description + #' Deserialize the content of api response to the given type. + #' + #' @param resp Response object. + #' @param return_type R return type. + #' @param pkg_env Package environment. + #' @return Deserialized object. + #' @export deserialize = function(resp, return_type, pkg_env) { resp_obj <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8")) self$deserializeObj(resp_obj, return_type, pkg_env) }, - - # Deserialize the response from jsonlite object based on the given type - # by handling complex and nested types by iterating recursively - # Example return_types will be like "array[integer]", "map(Pet)", "array[map(Tag)]", etc., - + #' Deserialize the response from jsonlite object based on the given type + #' + #' @description + #' Deserialize the response from jsonlite object based on the given type + #' by handling complex and nested types by iterating recursively + #' Example return_types will be like "array[integer]", "map(Pet)", "array[map(Tag)]", etc., + #' + #' @param obj Response object. + #' @param return_type R return type. + #' @param pkg_env Package environment. + #' @return Deserialized object. + #' @export deserializeObj = function(obj, return_type, pkg_env) { return_obj <- NULL primitive_types <- c("character", "numeric", "integer", "logical", "complex") diff --git a/samples/client/petstore/R/R/pig.R b/samples/client/petstore/R/R/pig.R index 5b84d3d9889..4887ec3d26c 100644 --- a/samples/client/petstore/R/R/pig.R +++ b/samples/client/petstore/R/R/pig.R @@ -32,7 +32,6 @@ Pig <- R6::R6Class( #' #' @param instance an instance of the object defined in the oneOf schemas: "BasquePig", "DanishPig" #' @export - #' @md initialize = function(instance = NULL) { if (is.null(instance)) { # do nothing @@ -54,7 +53,6 @@ Pig <- R6::R6Class( #' @param input The input JSON. #' @return An instance of Pig. #' @export - #' @md fromJSON = function(input) { matched <- 0 # match counter matched_schemas <- list() #names of matched schemas @@ -112,7 +110,6 @@ Pig <- R6::R6Class( #' #' @return JSON string reprenation of the Pig. #' @export - #' @md toJSON = function() { if (!is.null(self$actual_instance)) { self$actual_instance$toJSONString() @@ -128,7 +125,6 @@ Pig <- R6::R6Class( #' #' @param input The input JSON. #' @export - #' @md validateJSON = function(input) { # backup current values actual_instance_bak <- self$actual_instance