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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -40,6 +42,8 @@ apiInstance.createUser(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](User.md)| Created user object |
@@ -54,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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -81,6 +87,8 @@ apiInstance.createUsersWithArrayInput(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](Array.md)| List of user object |
@@ -95,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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -122,6 +132,8 @@ apiInstance.createUsersWithListInput(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](Array.md)| List of user object |
@@ -136,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
@@ -148,6 +161,7 @@ Delete user
This can only be done by the logged in user.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -165,6 +179,8 @@ apiInstance.deleteUser(username, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be deleted |
@@ -179,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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -206,6 +224,8 @@ apiInstance.getUserByName(username, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be fetched. Use user1 for testing. |
@@ -220,16 +240,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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -248,6 +270,8 @@ apiInstance.loginUser(username, password, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The user name for login |
@@ -263,16 +287,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
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -288,6 +314,7 @@ apiInstance.logoutUser(callback);
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -300,11 +327,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
@@ -312,6 +340,7 @@ Updated user
This can only be done by the logged in user.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -330,6 +359,8 @@ apiInstance.updateUser(username, body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted |
@@ -345,6 +376,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined