update samples

This commit is contained in:
William Cheng
2019-03-25 22:44:05 +08:00
parent 3810d12086
commit f015363dbd
1398 changed files with 9844 additions and 4221 deletions

View File

@@ -14,8 +14,9 @@ Method | HTTP request | Description
[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
<a name="createUser"></a>
# **createUser**
## createUser
> createUser(body)
Create user
@@ -23,6 +24,7 @@ Create user
This can only be done by the logged in user.
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -41,6 +43,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](User.md)| Created user object |
@@ -55,16 +58,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## createUsersWithArrayInput
<a name="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
Creates list of users with given input array
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -83,6 +88,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List&lt;User&gt;**](List.md)| List of user object |
@@ -97,16 +103,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## createUsersWithListInput
<a name="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
Creates list of users with given input array
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -125,6 +133,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List&lt;User&gt;**](List.md)| List of user object |
@@ -139,11 +148,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## deleteUser
<a name="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
Delete user
@@ -151,6 +161,7 @@ Delete user
This can only be done by the logged in user.
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -169,6 +180,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be deleted |
@@ -183,16 +195,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## getUserByName
<a name="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
Get user by user name
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -212,6 +226,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be fetched. Use user1 for testing. |
@@ -226,16 +241,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## loginUser
<a name="loginUser"></a>
# **loginUser**
> String loginUser(username, password)
Logs user into the system
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -256,6 +273,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The user name for login |
@@ -271,16 +289,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## logoutUser
<a name="logoutUser"></a>
# **logoutUser**
> logoutUser()
Logs out current logged in user session
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -297,6 +317,7 @@ try {
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -309,11 +330,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## updateUser
<a name="updateUser"></a>
# **updateUser**
> updateUser(username, body)
Updated user
@@ -321,6 +343,7 @@ Updated user
This can only be done by the logged in user.
### Example
```java
// Import classes:
//import org.openapitools.client.ApiException;
@@ -340,6 +363,7 @@ try {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted |
@@ -355,6 +379,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined