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,7 +14,9 @@ Method | HTTP request | Description
[**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user
# **create_user**
## create_user
> create_user(body)
Create user
@@ -22,6 +24,7 @@ Create user
This can only be done by the logged in user.
### Example
```ruby
# load the gem
require 'petstore'
@@ -39,6 +42,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](User.md)| Created user object |
@@ -53,17 +57,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## create_users_with_array_input
# **create_users_with_array_input**
> create_users_with_array_input(body)
Creates list of users with given input array
### Example
```ruby
# load the gem
require 'petstore'
@@ -81,6 +86,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Array<User>**](Array.md)| List of user object |
@@ -95,17 +101,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## create_users_with_list_input
# **create_users_with_list_input**
> create_users_with_list_input(body)
Creates list of users with given input array
### Example
```ruby
# load the gem
require 'petstore'
@@ -123,6 +130,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Array<User>**](Array.md)| List of user object |
@@ -137,12 +145,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## delete_user
# **delete_user**
> delete_user(username)
Delete user
@@ -150,6 +158,7 @@ Delete user
This can only be done by the logged in user.
### Example
```ruby
# load the gem
require 'petstore'
@@ -167,6 +176,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be deleted |
@@ -181,17 +191,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## get_user_by_name
# **get_user_by_name**
> User get_user_by_name(username)
Get user by user name
### Example
```ruby
# load the gem
require 'petstore'
@@ -210,6 +221,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be fetched. Use user1 for testing. |
@@ -224,17 +236,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
## login_user
# **login_user**
> String login_user(username, password)
Logs user into the system
### Example
```ruby
# load the gem
require 'petstore'
@@ -254,6 +267,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The user name for login |
@@ -269,17 +283,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
## logout_user
# **logout_user**
> logout_user
Logs out current logged in user session
### Example
```ruby
# load the gem
require 'petstore'
@@ -295,6 +310,7 @@ end
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -307,12 +323,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## update_user
# **update_user**
> update_user(username, body)
Updated user
@@ -320,6 +336,7 @@ Updated user
This can only be done by the logged in user.
### Example
```ruby
# load the gem
require 'petstore'
@@ -338,6 +355,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted |
@@ -353,8 +371,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined