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

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesAnyType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesArray
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesBoolean
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**map_string** | **Hash<String, String>** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesInteger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesNumber
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::AdditionalPropertiesString
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Animal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **String** | |

View File

@@ -7,7 +7,9 @@ Method | HTTP request | Description
[**call_123_test_special_tags**](AnotherFakeApi.md#call_123_test_special_tags) | **PATCH** /another-fake/dummy | To test special tags
# **call_123_test_special_tags**
## call_123_test_special_tags
> Client call_123_test_special_tags(body)
To test special tags
@@ -15,6 +17,7 @@ To test special tags
To test special tags and operation ID starting with number
### Example
```ruby
# load the gem
require 'petstore'
@@ -33,6 +36,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -47,8 +51,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# Petstore::ApiResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::ArrayOfArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_array_number** | **Array<Array<Float>>** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::ArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_number** | **Array<Float>** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::ArrayTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_of_string** | **Array<String>** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Capitalization
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**small_camel** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Cat
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**declawed** | **Boolean** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::ClassModel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_class** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Dog
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**breed** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::EnumArrays
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**just_symbol** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::EnumClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

View File

@@ -1,6 +1,7 @@
# Petstore::EnumTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enum_string** | **String** | | [optional]

View File

@@ -19,7 +19,9 @@ Method | HTTP request | Description
[**test_json_form_data**](FakeApi.md#test_json_form_data) | **GET** /fake/jsonFormData | test json serialization of form data
# **create_xml_item**
## create_xml_item
> create_xml_item(xml_item)
creates an XmlItem
@@ -27,6 +29,7 @@ creates an XmlItem
this route creates an XmlItem
### Example
```ruby
# load the gem
require 'petstore'
@@ -44,6 +47,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xml_item** | [**XmlItem**](XmlItem.md)| XmlItem Body |
@@ -58,12 +62,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
## fake_outer_boolean_serialize
# **fake_outer_boolean_serialize**
> Boolean fake_outer_boolean_serialize(opts)
@@ -71,6 +75,7 @@ No authorization required
Test serialization of outer boolean types
### Example
```ruby
# load the gem
require 'petstore'
@@ -90,6 +95,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Boolean**| Input boolean as post body | [optional]
@@ -104,12 +110,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fake_outer_composite_serialize
# **fake_outer_composite_serialize**
> OuterComposite fake_outer_composite_serialize(opts)
@@ -117,6 +123,7 @@ No authorization required
Test serialization of object with outer number type
### Example
```ruby
# load the gem
require 'petstore'
@@ -136,6 +143,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional]
@@ -150,12 +158,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fake_outer_number_serialize
# **fake_outer_number_serialize**
> Float fake_outer_number_serialize(opts)
@@ -163,6 +171,7 @@ No authorization required
Test serialization of outer number types
### Example
```ruby
# load the gem
require 'petstore'
@@ -182,6 +191,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Float**| Input number as post body | [optional]
@@ -196,12 +206,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fake_outer_string_serialize
# **fake_outer_string_serialize**
> String fake_outer_string_serialize(opts)
@@ -209,6 +219,7 @@ No authorization required
Test serialization of outer string types
### Example
```ruby
# load the gem
require 'petstore'
@@ -228,6 +239,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **String**| Input string as post body | [optional]
@@ -242,12 +254,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## test_body_with_file_schema
# **test_body_with_file_schema**
> test_body_with_file_schema(body)
@@ -255,6 +267,7 @@ No authorization required
For this test, the body for this request much reference a schema named `File`.
### Example
```ruby
# load the gem
require 'petstore'
@@ -271,6 +284,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| |
@@ -285,17 +299,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## test_body_with_query_params
# **test_body_with_query_params**
> test_body_with_query_params(query, body)
### Example
```ruby
# load the gem
require 'petstore'
@@ -313,6 +328,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **String**| |
@@ -328,12 +344,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## test_client_model
# **test_client_model**
> Client test_client_model(body)
To test \"client\" model
@@ -341,6 +357,7 @@ To test \"client\" model
To test \"client\" model
### Example
```ruby
# load the gem
require 'petstore'
@@ -359,6 +376,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -373,12 +391,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json
## test_endpoint_parameters
# **test_endpoint_parameters**
> test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -386,6 +404,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
### Example
```ruby
# load the gem
require 'petstore'
@@ -424,6 +443,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**number** | **Float**| None |
@@ -451,12 +471,12 @@ nil (empty response body)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## test_enum_parameters
# **test_enum_parameters**
> test_enum_parameters(opts)
To test enum parameters
@@ -464,6 +484,7 @@ To test enum parameters
To test enum parameters
### Example
```ruby
# load the gem
require 'petstore'
@@ -490,6 +511,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enum_header_string_array** | [**Array<String>**](String.md)| Header parameter enum test (string array) | [optional]
@@ -511,12 +533,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## test_group_parameters
# **test_group_parameters**
> test_group_parameters(required_string_group, required_boolean_group, required_int64_group, opts)
Fake endpoint to test group parameters (optional)
@@ -524,6 +546,7 @@ Fake endpoint to test group parameters (optional)
Fake endpoint to test group parameters (optional)
### Example
```ruby
# load the gem
require 'petstore'
@@ -548,6 +571,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**required_string_group** | **Integer**| Required String in group parameters |
@@ -567,17 +591,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## test_inline_additional_properties
# **test_inline_additional_properties**
> test_inline_additional_properties(param)
test inline additionalProperties
### Example
```ruby
# load the gem
require 'petstore'
@@ -595,6 +620,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | [**Hash<String, String>**](String.md)| request body |
@@ -609,17 +635,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## test_json_form_data
# **test_json_form_data**
> test_json_form_data(param, param2)
test json serialization of form data
### Example
```ruby
# load the gem
require 'petstore'
@@ -638,6 +665,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | **String**| field1 |
@@ -653,8 +681,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined

View File

@@ -7,7 +7,9 @@ Method | HTTP request | Description
[**test_classname**](FakeClassnameTags123Api.md#test_classname) | **PATCH** /fake_classname_test | To test class name in snake case
# **test_classname**
## test_classname
> Client test_classname(body)
To test class name in snake case
@@ -15,6 +17,7 @@ To test class name in snake case
To test class name in snake case
### Example
```ruby
# load the gem
require 'petstore'
@@ -40,6 +43,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -54,8 +58,6 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# Petstore::File
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_uri** | **String** | Test capitalization | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::FileSchemaTestClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file** | **File** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::FormatTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integer** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::HasOnlyReadOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::List
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_123_list** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::MapTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**map_map_of_string** | **Hash<String, Hash<String, String>>** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::MixedPropertiesAndAdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Model200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::ModelReturn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_return** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **Integer** | |

View File

@@ -1,6 +1,7 @@
# Petstore::NumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**just_number** | **Float** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::Order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::OuterComposite
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**my_number** | **Float** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::OuterEnum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

View File

@@ -1,6 +1,7 @@
# Petstore::Pet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | | [optional]

View File

@@ -15,12 +15,15 @@ Method | HTTP request | Description
[**upload_file_with_required_file**](PetApi.md#upload_file_with_required_file) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
# **add_pet**
## add_pet
> add_pet(body)
Add a new pet to the store
### Example
```ruby
# load the gem
require 'petstore'
@@ -43,6 +46,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
@@ -57,17 +61,18 @@ nil (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
## delete_pet
# **delete_pet**
> delete_pet(pet_id, opts)
Deletes a pet
### Example
```ruby
# load the gem
require 'petstore'
@@ -93,6 +98,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | **Integer**| Pet id to delete |
@@ -108,12 +114,12 @@ nil (empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## find_pets_by_status
# **find_pets_by_status**
> Array<Pet> find_pets_by_status(status)
Finds Pets by status
@@ -121,6 +127,7 @@ Finds Pets by status
Multiple status values can be provided with comma separated strings
### Example
```ruby
# load the gem
require 'petstore'
@@ -144,6 +151,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**Array<String>**](String.md)| Status values that need to be considered for filter |
@@ -158,12 +166,12 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## find_pets_by_tags
# **find_pets_by_tags**
> Array<Pet> find_pets_by_tags(tags)
Finds Pets by tags
@@ -171,6 +179,7 @@ Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
### Example
```ruby
# load the gem
require 'petstore'
@@ -194,6 +203,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tags** | [**Array<String>**](String.md)| Tags to filter by |
@@ -208,12 +218,12 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## get_pet_by_id
# **get_pet_by_id**
> Pet get_pet_by_id(pet_id)
Find pet by ID
@@ -221,6 +231,7 @@ Find pet by ID
Returns a single pet
### Example
```ruby
# load the gem
require 'petstore'
@@ -246,6 +257,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | **Integer**| ID of pet to return |
@@ -260,17 +272,18 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## update_pet
# **update_pet**
> update_pet(body)
Update an existing pet
### Example
```ruby
# load the gem
require 'petstore'
@@ -293,6 +306,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
@@ -307,17 +321,18 @@ nil (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
## update_pet_with_form
# **update_pet_with_form**
> update_pet_with_form(pet_id, opts)
Updates a pet in the store with form data
### Example
```ruby
# load the gem
require 'petstore'
@@ -344,6 +359,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | **Integer**| ID of pet that needs to be updated |
@@ -360,17 +376,18 @@ nil (empty response body)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## upload_file
# **upload_file**
> ApiResponse upload_file(pet_id, opts)
uploads an image
### Example
```ruby
# load the gem
require 'petstore'
@@ -398,6 +415,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | **Integer**| ID of pet to update |
@@ -414,17 +432,18 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
- **Content-Type**: multipart/form-data
- **Accept**: application/json
## upload_file_with_required_file
# **upload_file_with_required_file**
> ApiResponse upload_file_with_required_file(pet_id, required_file, opts)
uploads an image (required)
### Example
```ruby
# load the gem
require 'petstore'
@@ -452,6 +471,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | **Integer**| ID of pet to update |
@@ -468,8 +488,6 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
- **Content-Type**: multipart/form-data
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# Petstore::ReadOnlyFirst
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::SpecialModelName
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**special_property_name** | **Integer** | | [optional]

View File

@@ -10,7 +10,9 @@ Method | HTTP request | Description
[**place_order**](StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
# **delete_order**
## delete_order
> delete_order(order_id)
Delete purchase order by ID
@@ -18,6 +20,7 @@ Delete purchase order by ID
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
### Example
```ruby
# load the gem
require 'petstore'
@@ -35,6 +38,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | **String**| ID of the order that needs to be deleted |
@@ -49,12 +53,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## get_inventory
# **get_inventory**
> Hash&lt;String, Integer&gt; get_inventory
Returns pet inventories by status
@@ -62,6 +66,7 @@ Returns pet inventories by status
Returns a map of status codes to quantities
### Example
```ruby
# load the gem
require 'petstore'
@@ -85,6 +90,7 @@ end
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -97,12 +103,12 @@ This endpoint does not need any parameter.
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json
## get_order_by_id
# **get_order_by_id**
> Order get_order_by_id(order_id)
Find purchase order by ID
@@ -110,6 +116,7 @@ Find purchase order by ID
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
### Example
```ruby
# load the gem
require 'petstore'
@@ -128,6 +135,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | **Integer**| ID of pet that needs to be fetched |
@@ -142,17 +150,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
## place_order
# **place_order**
> Order place_order(body)
Place an order for a pet
### Example
```ruby
# load the gem
require 'petstore'
@@ -171,6 +180,7 @@ end
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](Order.md)| order placed for purchasing the pet |
@@ -185,8 +195,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json

View File

@@ -1,6 +1,7 @@
# Petstore::Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | | [optional]

View File

@@ -1,6 +1,7 @@
# Petstore::TypeHolderDefault
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**string_item** | **String** | | [default to &#39;what&#39;]

View File

@@ -1,6 +1,7 @@
# Petstore::TypeHolderExample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**string_item** | **String** | |

View File

@@ -1,6 +1,7 @@
# Petstore::User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | | [optional]

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&lt;User&gt;**](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&lt;User&gt;**](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

View File

@@ -1,6 +1,7 @@
# Petstore::XmlItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute_string** | **String** | | [optional]