loafle/openapi-generator-original

Fork 1

mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-14 05:30:51 +00:00

William Cheng dc23ba3a23

fix example code reported by styler (#13707 )

2022-10-17 01:49:39 +08:00

13 KiB

Raw Permalink Blame History

UserApi

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
CreateUser	POST /user	Create user
CreateUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
CreateUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
DeleteUser	DELETE /user/{username}	Delete user
GetUserByName	GET /user/{username}	Get user by user name
LoginUser	GET /user/login	Logs user into the system
LogoutUser	GET /user/logout	Logs out current logged in user session
UpdateUser	PUT /user/{username}	Updated user

CreateUser

CreateUser(user)

Create user

This can only be done by the logged in user.

Example

library(petstore)

# Create user
#
# prepare function argument(s)
var_user <- User$new(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) # User | Created user object

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$CreateUser(var_user),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `CreateUser`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

Name	Type	Description	Notes
user	User	Created user object

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

CreateUsersWithArrayInput

CreateUsersWithArrayInput(user)

Creates list of users with given input array

Example

library(petstore)

# Creates list of users with given input array
#
# prepare function argument(s)
var_user <- c(User$new(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)) # array[User] | List of user object

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$CreateUsersWithArrayInput(var_user),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `CreateUsersWithArrayInput`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

Name	Type	Description	Notes
user	list( User )	List of user object

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

CreateUsersWithListInput

CreateUsersWithListInput(user)

Creates list of users with given input array

Example

library(petstore)

# Creates list of users with given input array
#
# prepare function argument(s)
var_user <- c(User$new(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)) # array[User] | List of user object

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$CreateUsersWithListInput(var_user),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `CreateUsersWithListInput`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

Name	Type	Description	Notes
user	list( User )	List of user object

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

DeleteUser

DeleteUser(username)

Delete user

This can only be done by the logged in user.

Example

library(petstore)

# Delete user
#
# prepare function argument(s)
var_username <- "username_example" # character | The name that needs to be deleted

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$DeleteUser(var_username),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `DeleteUser`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

Name	Type	Description	Notes
username	character	The name that needs to be deleted

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid username supplied	-
404	User not found	-

GetUserByName

User GetUserByName(username)

Get user by user name

Example

library(petstore)

# Get user by user name
#
# prepare function argument(s)
var_username <- "username_example" # character | The name that needs to be fetched. Use user1 for testing.

api_instance <- UserApi$new()
result <- tryCatch(
             # to save the result into a file, simply add the optional `data_file` parameter, e.g.
             # api_instance$GetUserByName(var_username, data_file = "result.txt"),
             api_instance$GetUserByName(var_username),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `GetUserByName`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
} else {
  # deserialized response object
  print("The response is ...")
  dput(result$toString())
}

Parameters

Name	Type	Description	Notes
username	character	The name that needs to be fetched. Use user1 for testing.

Return type

User

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Invalid username supplied	-
404	User not found	-

LoginUser

character LoginUser(username, password)

Logs user into the system

Example

library(petstore)

# Logs user into the system
#
# prepare function argument(s)
var_username <- "username_example" # character | The user name for login
var_password <- "password_example" # character | The password for login in clear text

api_instance <- UserApi$new()
result <- tryCatch(
             # to save the result into a file, simply add the optional `data_file` parameter, e.g.
             # api_instance$LoginUser(var_username, var_password, data_file = "result.txt"),
             api_instance$LoginUser(var_username, var_password),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `LoginUser`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
} else {
  # deserialized response object
  print("The response is ...")
  dput(result$toString())
}

Parameters

Name	Type	Description	Notes
username	character	The user name for login
password	character	The password for login in clear text

Return type

character

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Set-Cookie - Cookie authentication key for use with the `api_key` apiKey authentication. * X-Rate-Limit - calls per hour allowed by the user * X-Expires-After - date in UTC when token expires
400	Invalid username/password supplied	-

LogoutUser

LogoutUser()

Logs out current logged in user session

Example

library(petstore)

# Logs out current logged in user session
#

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$LogoutUser(),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `LogoutUser`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

UpdateUser

UpdateUser(username, user)

Updated user

This can only be done by the logged in user.

Example

library(petstore)

# Updated user
#
# prepare function argument(s)
var_username <- "username_example" # character | name that need to be deleted
var_user <- User$new(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) # User | Updated user object

api_instance <- UserApi$new()
# Configure API key authorization: api_key
api_instance$api_client$api_keys["api_key"] <- Sys.getenv("API_KEY")
result <- tryCatch(
             api_instance$UpdateUser(var_username, var_user),
             ApiException = function(ex) ex
          )
# In case of error, print the error object
if (!is.null(result$ApiException)) {
  print("Exception occurs when calling `UpdateUser`:")
  dput(result$ApiException$toString())
  # error object
  dput(result$ApiException$error_object$toJSONString())
}
# This endpoint doesn't return data

Parameters

Name	Type	Description	Notes
username	character	name that need to be deleted
user	User	Updated user object

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid user supplied	-
404	User not found	-

13 KiB Raw Permalink Blame History

UserApi

CreateUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateUsersWithArrayInput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateUsersWithListInput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetUserByName

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

LoginUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

LogoutUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

13 KiB

Raw Permalink Blame History