forked from loafle/openapi-generator-original
232 lines
5.0 KiB
Markdown
232 lines
5.0 KiB
Markdown
# UserApi
|
|
|
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**createUser**](UserApi.md#createUser) | **POST** /user | Create user |
|
|
| [**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array |
|
|
| [**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array |
|
|
| [**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user |
|
|
| [**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name |
|
|
| [**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system |
|
|
| [**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session |
|
|
| [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user |
|
|
|
|
|
|
<a name="createUser"></a>
|
|
# **createUser**
|
|
> createUser(User)
|
|
|
|
Create user
|
|
|
|
This can only be done by the logged in user.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **User** | [**User**](../Models/User.md)| Created user object | |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: Not defined
|
|
|
|
<a name="createUsersWithArrayInput"></a>
|
|
# **createUsersWithArrayInput**
|
|
> createUsersWithArrayInput(User)
|
|
|
|
Creates list of users with given input array
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **User** | [**List**](../Models/User.md)| List of user object | |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: Not defined
|
|
|
|
<a name="createUsersWithListInput"></a>
|
|
# **createUsersWithListInput**
|
|
> createUsersWithListInput(User)
|
|
|
|
Creates list of users with given input array
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **User** | [**List**](../Models/User.md)| List of user object | |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: Not defined
|
|
|
|
<a name="deleteUser"></a>
|
|
# **deleteUser**
|
|
> deleteUser(username)
|
|
|
|
Delete user
|
|
|
|
This can only be done by the logged in user.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **username** | **String**| The name that needs to be deleted | [default to null] |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
<a name="getUserByName"></a>
|
|
# **getUserByName**
|
|
> User getUserByName(username)
|
|
|
|
Get user by user name
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **username** | **String**| The name that needs to be fetched. Use user1 for testing. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**User**](../Models/User.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/xml, application/json
|
|
|
|
<a name="loginUser"></a>
|
|
# **loginUser**
|
|
> String loginUser(username, password)
|
|
|
|
Logs user into the system
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **username** | **String**| The user name for login | [default to null] |
|
|
| **password** | **String**| The password for login in clear text | [default to null] |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/xml, application/json
|
|
|
|
<a name="logoutUser"></a>
|
|
# **logoutUser**
|
|
> logoutUser()
|
|
|
|
Logs out current logged in user session
|
|
|
|
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
<a name="updateUser"></a>
|
|
# **updateUser**
|
|
> updateUser(username, User)
|
|
|
|
Updated user
|
|
|
|
This can only be done by the logged in user.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **username** | **String**| name that need to be deleted | [default to null] |
|
|
| **User** | [**User**](../Models/User.md)| Updated user object | |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: Not defined
|
|
|