Skip to content

UserApi.md

Latest commit

 

History

History
236 lines (142 loc) · 6.65 KB

UserApi.md

File metadata and controls

236 lines (142 loc) · 6.65 KB

UserApi

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

Method HTTP request Description
create_user POST /user Create user
create_users_with_array_input POST /user/createWithArray Creates list of users with given input array
create_users_with_list_input POST /user/createWithList Creates list of users with given input array
delete_user DELETE /user/{username} Delete user
get_user_by_name GET /user/{username} Get user by user name
login_user GET /user/login Logs user into the system
logout_user GET /user/logout Logs out current logged in user session
update_user PUT /user/{username} Updated user

create_user

create_user(req::HTTP.Request, body::User;) -> Nothing

Create user

This can only be done by the logged in user.

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
body User Created user object

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_users_with_array_input

create_users_with_array_input(req::HTTP.Request, body::Vector{User};) -> Nothing

Creates list of users with given input array

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
body Vector{User} List of user object

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_users_with_list_input

create_users_with_list_input(req::HTTP.Request, body::Vector{User};) -> Nothing

Creates list of users with given input array

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
body Vector{User} List of user object

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user

delete_user(req::HTTP.Request, username::String;) -> Nothing

Delete user

This can only be done by the logged in user.

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
username String The name that needs to be deleted

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_by_name

get_user_by_name(req::HTTP.Request, username::String;) -> User

Get user by user name

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
username String 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/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

login_user

login_user(req::HTTP.Request, username::String, password::String;) -> String

Logs user into the system

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
username String The user name for login
password String The password for login in clear text

Return type

String

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

logout_user

logout_user(req::HTTP.Request;) -> Nothing

Logs out current logged in user session

Required Parameters

This endpoint does not need any parameter.

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

update_user(req::HTTP.Request, username::String, body::User;) -> Nothing

Updated user

This can only be done by the logged in user.

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
username String name that need to be updated
body User Updated user object

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]