loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

update r api doc (#12679)

Browse Source
This commit is contained in:
William Cheng 2022-06-24 10:39:48 +08:00 committed by GitHub
parent c3970d7348
commit f5e701c459
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 483 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
modules/openapi-generator/src/main/resources/r/api.mustache vendored
View File

@ -150,6 +150,13 @@
"{{classname}}",
public = list(
api_client = NULL,
#' Initialize a new {{{classname}}}.
#'
#' @description
#' Initialize a new {{{classname}}}.
#'
#' @param api_client An instance of API client.
#' @export
initialize = function(api_client) {
if (!missing(api_client)) {
self$api_client <- api_client
@ -159,6 +166,23 @@
}
},
{{#operation}}
#' {{{summary}}}
#'
#' @description
#' {{{description}}}{{^description}}{{{summary}}}{{/description}}
#'
{{#requiredParams}}
#' @param {{{paramName}}} {{{description}}}
{{/requiredParams}}
{{#optionalParams}}
#' @param {{{paramName}}} (optional) {{{description}}}{{#defaultValue}} (default value: {{{.}}}){{/defaultValue}}
{{/optionalParams}}
{{#returnType}}
#' @param data_file (optional) name of the data file to save the result
{{/returnType}}
#' @param ... Other optional arguments
#' @return {{{returnType}}}{{^returnType}}void{{/returnType}}
#' @export
{{{operationId}}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}}={{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#returnType}}data_file=NULL, {{/returnType}}...) {
api_response <- self${{{operationId}}}WithHttpInfo({{#allParams}}{{paramName}}, {{/allParams}}{{#returnType}}data_file = data_file, {{/returnType}}...)
resp <- api_response$response
@ -172,7 +196,23 @@
api_response
}
},
#' {{{summary}}}
#'
#' @description
#' {{{description}}}{{^description}}{{{summary}}}{{/description}}
#'
{{#requiredParams}}
#' @param {{{paramName}}} {{{description}}}
{{/requiredParams}}
{{#optionalParams}}
#' @param {{{paramName}}} (optional) {{{description}}}{{#defaultValue}} (default value: {{{.}}}){{/defaultValue}}
{{/optionalParams}}
{{#returnType}}
#' @param data_file (optional) name of the data file to save the result
{{/returnType}}
#' @param ... Other optional arguments
#' @return API response ({{{returnType}}}{{^returnType}}void{{/returnType}}) with additional information such as HTTP status code, headers
#' @export
{{{operationId}}}WithHttpInfo = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}}={{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#returnType}}data_file = NULL, {{/returnType}}...) {
args <- list(...)
query_params <- list()

30
samples/client/petstore/R/R/fake_api.R
View File

@ -73,6 +73,13 @@ FakeApi <- R6::R6Class(
"FakeApi",
public = list(
api_client = NULL,
#' Initialize a new FakeApi.
#'
#' @description
#' Initialize a new FakeApi.
#'
#' @param api_client An instance of API client.
#' @export
initialize = function(api_client) {
if (!missing(api_client)) {
self$api_client <- api_client
@ -81,6 +88,17 @@ FakeApi <- R6::R6Class(
self$api_client <- ApiClient$new()
}
},
#' test data_file to ensure it's escaped correctly
#'
#' @description
#' test data_file to ensure it's escaped correctly
#'
#' @param dummy dummy required parameter
#' @param var_data_file (optional) header data file
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return User
#' @export
FakeDataFile = function(dummy, var_data_file=NULL, data_file=NULL, ...) {
api_response <- self$FakeDataFileWithHttpInfo(dummy, var_data_file, data_file = data_file, ...)
resp <- api_response$response
@ -94,7 +112,17 @@ FakeApi <- R6::R6Class(
api_response
}
},
#' test data_file to ensure it's escaped correctly
#'
#' @description
#' test data_file to ensure it's escaped correctly
#'
#' @param dummy dummy required parameter
#' @param var_data_file (optional) header data file
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (User) with additional information such as HTTP status code, headers
#' @export
FakeDataFileWithHttpInfo = function(dummy, var_data_file=NULL, data_file = NULL, ...) {
args <- list(...)
query_params <- list()

181
samples/client/petstore/R/R/pet_api.R
View File

@ -456,6 +456,13 @@ PetApi <- R6::R6Class(
"PetApi",
public = list(
api_client = NULL,
#' Initialize a new PetApi.
#'
#' @description
#' Initialize a new PetApi.
#'
#' @param api_client An instance of API client.
#' @export
initialize = function(api_client) {
if (!missing(api_client)) {
self$api_client <- api_client
@ -464,6 +471,16 @@ PetApi <- R6::R6Class(
self$api_client <- ApiClient$new()
}
},
#' Add a new pet to the store
#'
#' @description
#' Add a new pet to the store
#'
#' @param pet Pet object that needs to be added to the store
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return Pet
#' @export
AddPet = function(pet, data_file=NULL, ...) {
api_response <- self$AddPetWithHttpInfo(pet, data_file = data_file, ...)
resp <- api_response$response
@ -477,7 +494,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Add a new pet to the store
#'
#' @description
#' Add a new pet to the store
#'
#' @param pet Pet object that needs to be added to the store
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (Pet) with additional information such as HTTP status code, headers
#' @export
AddPetWithHttpInfo = function(pet, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -537,6 +563,16 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Deletes a pet
#'
#' @description
#' Deletes a pet
#'
#' @param pet_id Pet id to delete
#' @param api_key (optional)
#' @param ... Other optional arguments
#' @return void
#' @export
DeletePet = function(pet_id, api_key=NULL, ...) {
api_response <- self$DeletePetWithHttpInfo(pet_id, api_key, ...)
resp <- api_response$response
@ -550,7 +586,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Deletes a pet
#'
#' @description
#' Deletes a pet
#'
#' @param pet_id Pet id to delete
#' @param api_key (optional)
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
DeletePetWithHttpInfo = function(pet_id, api_key=NULL, ...) {
args <- list(...)
query_params <- list()
@ -598,6 +643,16 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Finds Pets by status
#'
#' @description
#' Finds Pets by status
#'
#' @param status Status values that need to be considered for filter
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return array[Pet]
#' @export
FindPetsByStatus = function(status, data_file=NULL, ...) {
api_response <- self$FindPetsByStatusWithHttpInfo(status, data_file = data_file, ...)
resp <- api_response$response
@ -611,7 +666,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Finds Pets by status
#'
#' @description
#' Finds Pets by status
#'
#' @param status Status values that need to be considered for filter
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (array[Pet]) with additional information such as HTTP status code, headers
#' @export
FindPetsByStatusWithHttpInfo = function(status, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -666,6 +730,16 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Finds Pets by tags
#'
#' @description
#' Finds Pets by tags
#'
#' @param tags Tags to filter by
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return array[Pet]
#' @export
FindPetsByTags = function(tags, data_file=NULL, ...) {
api_response <- self$FindPetsByTagsWithHttpInfo(tags, data_file = data_file, ...)
resp <- api_response$response
@ -679,7 +753,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Finds Pets by tags
#'
#' @description
#' Finds Pets by tags
#'
#' @param tags Tags to filter by
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (array[Pet]) with additional information such as HTTP status code, headers
#' @export
FindPetsByTagsWithHttpInfo = function(tags, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -734,6 +817,16 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Find pet by ID
#'
#' @description
#' Find pet by ID
#'
#' @param pet_id ID of pet to return
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return Pet
#' @export
GetPetById = function(pet_id, data_file=NULL, ...) {
api_response <- self$GetPetByIdWithHttpInfo(pet_id, data_file = data_file, ...)
resp <- api_response$response
@ -747,7 +840,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Find pet by ID
#'
#' @description
#' Find pet by ID
#'
#' @param pet_id ID of pet to return
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (Pet) with additional information such as HTTP status code, headers
#' @export
GetPetByIdWithHttpInfo = function(pet_id, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -808,6 +910,16 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Update an existing pet
#'
#' @description
#' Update an existing pet
#'
#' @param pet Pet object that needs to be added to the store
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return Pet
#' @export
UpdatePet = function(pet, data_file=NULL, ...) {
api_response <- self$UpdatePetWithHttpInfo(pet, data_file = data_file, ...)
resp <- api_response$response
@ -821,7 +933,16 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Update an existing pet
#'
#' @description
#' Update an existing pet
#'
#' @param pet Pet object that needs to be added to the store
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (Pet) with additional information such as HTTP status code, headers
#' @export
UpdatePetWithHttpInfo = function(pet, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -881,6 +1002,17 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Updates a pet in the store with form data
#'
#' @description
#' Updates a pet in the store with form data
#'
#' @param pet_id ID of pet that needs to be updated
#' @param name (optional) Updated name of the pet
#' @param status (optional) Updated status of the pet
#' @param ... Other optional arguments
#' @return void
#' @export
UpdatePetWithForm = function(pet_id, name=NULL, status=NULL, ...) {
api_response <- self$UpdatePetWithFormWithHttpInfo(pet_id, name, status, ...)
resp <- api_response$response
@ -894,7 +1026,17 @@ PetApi <- R6::R6Class(
api_response
}
},
#' Updates a pet in the store with form data
#'
#' @description
#' Updates a pet in the store with form data
#'
#' @param pet_id ID of pet that needs to be updated
#' @param name (optional) Updated name of the pet
#' @param status (optional) Updated status of the pet
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
UpdatePetWithFormWithHttpInfo = function(pet_id, name=NULL, status=NULL, ...) {
args <- list(...)
query_params <- list()
@ -946,6 +1088,18 @@ PetApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' uploads an image
#'
#' @description
#' uploads an image
#'
#' @param pet_id ID of pet to update
#' @param additional_metadata (optional) Additional data to pass to server
#' @param file (optional) file to upload
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return ModelApiResponse
#' @export
UploadFile = function(pet_id, additional_metadata=NULL, file=NULL, data_file=NULL, ...) {
api_response <- self$UploadFileWithHttpInfo(pet_id, additional_metadata, file, data_file = data_file, ...)
resp <- api_response$response
@ -959,7 +1113,18 @@ PetApi <- R6::R6Class(
api_response
}
},
#' uploads an image
#'
#' @description
#' uploads an image
#'
#' @param pet_id ID of pet to update
#' @param additional_metadata (optional) Additional data to pass to server
#' @param file (optional) file to upload
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (ModelApiResponse) with additional information such as HTTP status code, headers
#' @export
UploadFileWithHttpInfo = function(pet_id, additional_metadata=NULL, file=NULL, data_file = NULL, ...) {
args <- list(...)
query_params <- list()

87
samples/client/petstore/R/R/store_api.R
View File

@ -225,6 +225,13 @@ StoreApi <- R6::R6Class(
"StoreApi",
public = list(
api_client = NULL,
#' Initialize a new StoreApi.
#'
#' @description
#' Initialize a new StoreApi.
#'
#' @param api_client An instance of API client.
#' @export
initialize = function(api_client) {
if (!missing(api_client)) {
self$api_client <- api_client
@ -233,6 +240,15 @@ StoreApi <- R6::R6Class(
self$api_client <- ApiClient$new()
}
},
#' Delete purchase order by ID
#'
#' @description
#' Delete purchase order by ID
#'
#' @param order_id ID of the order that needs to be deleted
#' @param ... Other optional arguments
#' @return void
#' @export
DeleteOrder = function(order_id, ...) {
api_response <- self$DeleteOrderWithHttpInfo(order_id, ...)
resp <- api_response$response
@ -246,7 +262,15 @@ StoreApi <- R6::R6Class(
api_response
}
},
#' Delete purchase order by ID
#'
#' @description
#' Delete purchase order by ID
#'
#' @param order_id ID of the order that needs to be deleted
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
DeleteOrderWithHttpInfo = function(order_id, ...) {
args <- list(...)
query_params <- list()
@ -292,6 +316,15 @@ StoreApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Returns pet inventories by status
#'
#' @description
#' Returns pet inventories by status
#'
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return map(integer)
#' @export
GetInventory = function(data_file=NULL, ...) {
api_response <- self$GetInventoryWithHttpInfo(data_file = data_file, ...)
resp <- api_response$response
@ -305,7 +338,15 @@ StoreApi <- R6::R6Class(
api_response
}
},
#' Returns pet inventories by status
#'
#' @description
#' Returns pet inventories by status
#'
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (map(integer)) with additional information such as HTTP status code, headers
#' @export
GetInventoryWithHttpInfo = function(data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -358,6 +399,16 @@ StoreApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Find purchase order by ID
#'
#' @description
#' Find purchase order by ID
#'
#' @param order_id ID of pet that needs to be fetched
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return Order
#' @export
GetOrderById = function(order_id, data_file=NULL, ...) {
api_response <- self$GetOrderByIdWithHttpInfo(order_id, data_file = data_file, ...)
resp <- api_response$response
@ -371,7 +422,16 @@ StoreApi <- R6::R6Class(
api_response
}
},
#' Find purchase order by ID
#'
#' @description
#' Find purchase order by ID
#'
#' @param order_id ID of pet that needs to be fetched
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (Order) with additional information such as HTTP status code, headers
#' @export
GetOrderByIdWithHttpInfo = function(order_id, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -428,6 +488,16 @@ StoreApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Place an order for a pet
#'
#' @description
#' Place an order for a pet
#'
#' @param order order placed for purchasing the pet
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return Order
#' @export
PlaceOrder = function(order, data_file=NULL, ...) {
api_response <- self$PlaceOrderWithHttpInfo(order, data_file = data_file, ...)
resp <- api_response$response
@ -441,7 +511,16 @@ StoreApi <- R6::R6Class(
api_response
}
},
#' Place an order for a pet
#'
#' @description
#' Place an order for a pet
#'
#' @param order order placed for purchasing the pet
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (Order) with additional information such as HTTP status code, headers
#' @export
PlaceOrderWithHttpInfo = function(order, data_file = NULL, ...) {
args <- list(...)
query_params <- list()

165
samples/client/petstore/R/R/user_api.R
View File

@ -411,6 +411,13 @@ UserApi <- R6::R6Class(
"UserApi",
public = list(
api_client = NULL,
#' Initialize a new UserApi.
#'
#' @description
#' Initialize a new UserApi.
#'
#' @param api_client An instance of API client.
#' @export
initialize = function(api_client) {
if (!missing(api_client)) {
self$api_client <- api_client
@ -419,6 +426,15 @@ UserApi <- R6::R6Class(
self$api_client <- ApiClient$new()
}
},
#' Create user
#'
#' @description
#' Create user
#'
#' @param user Created user object
#' @param ... Other optional arguments
#' @return void
#' @export
CreateUser = function(user, ...) {
api_response <- self$CreateUserWithHttpInfo(user, ...)
resp <- api_response$response
@ -432,7 +448,15 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Create user
#'
#' @description
#' Create user
#'
#' @param user Created user object
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
CreateUserWithHttpInfo = function(user, ...) {
args <- list(...)
query_params <- list()
@ -483,6 +507,15 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Creates list of users with given input array
#'
#' @description
#' Creates list of users with given input array
#'
#' @param user List of user object
#' @param ... Other optional arguments
#' @return void
#' @export
CreateUsersWithArrayInput = function(user, ...) {
api_response <- self$CreateUsersWithArrayInputWithHttpInfo(user, ...)
resp <- api_response$response
@ -496,7 +529,15 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Creates list of users with given input array
#'
#' @description
#' Creates list of users with given input array
#'
#' @param user List of user object
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
CreateUsersWithArrayInputWithHttpInfo = function(user, ...) {
args <- list(...)
query_params <- list()
@ -548,6 +589,15 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Creates list of users with given input array
#'
#' @description
#' Creates list of users with given input array
#'
#' @param user List of user object
#' @param ... Other optional arguments
#' @return void
#' @export
CreateUsersWithListInput = function(user, ...) {
api_response <- self$CreateUsersWithListInputWithHttpInfo(user, ...)
resp <- api_response$response
@ -561,7 +611,15 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Creates list of users with given input array
#'
#' @description
#' Creates list of users with given input array
#'
#' @param user List of user object
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
CreateUsersWithListInputWithHttpInfo = function(user, ...) {
args <- list(...)
query_params <- list()
@ -613,6 +671,15 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Delete user
#'
#' @description
#' Delete user
#'
#' @param username The name that needs to be deleted
#' @param ... Other optional arguments
#' @return void
#' @export
DeleteUser = function(username, ...) {
api_response <- self$DeleteUserWithHttpInfo(username, ...)
resp <- api_response$response
@ -626,7 +693,15 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Delete user
#'
#' @description
#' Delete user
#'
#' @param username The name that needs to be deleted
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
DeleteUserWithHttpInfo = function(username, ...) {
args <- list(...)
query_params <- list()
@ -676,6 +751,16 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Get user by user name
#'
#' @description
#' Get user by user name
#'
#' @param username The name that needs to be fetched. Use user1 for testing.
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return User
#' @export
GetUserByName = function(username, data_file=NULL, ...) {
api_response <- self$GetUserByNameWithHttpInfo(username, data_file = data_file, ...)
resp <- api_response$response
@ -689,7 +774,16 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Get user by user name
#'
#' @description
#' Get user by user name
#'
#' @param username The name that needs to be fetched. Use user1 for testing.
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (User) with additional information such as HTTP status code, headers
#' @export
GetUserByNameWithHttpInfo = function(username, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -746,6 +840,17 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Logs user into the system
#'
#' @description
#' Logs user into the system
#'
#' @param username The user name for login
#' @param password The password for login in clear text
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return character
#' @export
LoginUser = function(username, password, data_file=NULL, ...) {
api_response <- self$LoginUserWithHttpInfo(username, password, data_file = data_file, ...)
resp <- api_response$response
@ -759,7 +864,17 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Logs user into the system
#'
#' @description
#' Logs user into the system
#'
#' @param username The user name for login
#' @param password The password for login in clear text
#' @param data_file (optional) name of the data file to save the result
#' @param ... Other optional arguments
#' @return API response (character) with additional information such as HTTP status code, headers
#' @export
LoginUserWithHttpInfo = function(username, password, data_file = NULL, ...) {
args <- list(...)
query_params <- list()
@ -816,6 +931,14 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Logs out current logged in user session
#'
#' @description
#' Logs out current logged in user session
#'
#' @param ... Other optional arguments
#' @return void
#' @export
LogoutUser = function(...) {
api_response <- self$LogoutUserWithHttpInfo(...)
resp <- api_response$response
@ -829,7 +952,14 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Logs out current logged in user session
#'
#' @description
#' Logs out current logged in user session
#'
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
LogoutUserWithHttpInfo = function(...) {
args <- list(...)
query_params <- list()
@ -871,6 +1001,16 @@ UserApi <- R6::R6Class(
rlang::abort(message = error_msg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp))
}
},
#' Updated user
#'
#' @description
#' Updated user
#'
#' @param username name that need to be deleted
#' @param user Updated user object
#' @param ... Other optional arguments
#' @return void
#' @export
UpdateUser = function(username, user, ...) {
api_response <- self$UpdateUserWithHttpInfo(username, user, ...)
resp <- api_response$response
@ -884,7 +1024,16 @@ UserApi <- R6::R6Class(
api_response
}
},
#' Updated user
#'
#' @description
#' Updated user
#'
#' @param username name that need to be deleted
#' @param user Updated user object
#' @param ... Other optional arguments
#' @return API response (void) with additional information such as HTTP status code, headers
#' @export
UpdateUserWithHttpInfo = function(username, user, ...) {
args <- list(...)
query_params <- list()