loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

update sample for html, flash

Browse Source
This commit is contained in:
wing328 2016-04-16 17:51:12 +08:00
parent 1fb3edc612
commit 7d0c963469
12 changed files with 408 additions and 1023 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
samples/client/petstore/flash/flash/src/io/swagger/client/api/PetApi.as
View File

@ -7,7 +7,7 @@ import io.swagger.common.ApiUserCredentials;
import io.swagger.event.Response;
import io.swagger.common.SwaggerApi;
import io.swagger.client.model.Pet;
import io.swagger.client.model.InlineResponse200;
import io.swagger.client.model.ApiResponse;
import flash.filesystem.File;
import mx.rpc.AsyncToken;
@ -26,13 +26,10 @@ public class PetApi extends SwaggerApi {
}
public static const event_add_pet: String = "add_pet";
public static const event_add_pet_using_byte_array: String = "add_pet_using_byte_array";
public static const event_delete_pet: String = "delete_pet";
public static const event_find_pets_by_status: String = "find_pets_by_status";
public static const event_find_pets_by_tags: String = "find_pets_by_tags";
public static const event_get_pet_by_id: String = "get_pet_by_id";
public static const event_get_pet_by_id_in_object: String = "get_pet_by_id_in_object";
public static const event_pet_pet_idtesting_byte_arraytrue_get: String = "pet_pet_idtesting_byte_arraytrue_get";
public static const event_update_pet: String = "update_pet";
public static const event_update_pet_with_form: String = "update_pet_with_form";
public static const event_upload_file: String = "upload_file";
@ -68,36 +65,6 @@ public class PetApi extends SwaggerApi {
}
/*
* Returns void
*/
public function add_pet_using_byte_array (body: String): String {
// create path and map variables
var path: String = "/pet?testing_byte_array=true".replace(/{format}/g,"xml");
// query params
var queryParams: Dictionary = new Dictionary();
var headerParams: Dictionary = new Dictionary();
// verify required params are set
if() {
throw new ApiError(400, "missing required params");
}
var token:AsyncToken = getApiInvoker().invokeAPI(path, "POST", queryParams, body, headerParams);
var requestId: String = getUniqueId();
token.requestId = requestId;
token.completionEventType = "add_pet_using_byte_array";
token.returnType = null ;
return requestId;
}
/*
* Returns void
*/
@ -227,66 +194,6 @@ public class PetApi extends SwaggerApi {
}
/*
* Returns InlineResponse200
*/
public function get_pet_by_id_in_object (petId: Number): String {
// create path and map variables
var path: String = "/pet/{petId}?response=inline_arbitrary_object".replace(/{format}/g,"xml").replace("{" + "petId" + "}", getApiInvoker().escapeString(petId));
// query params
var queryParams: Dictionary = new Dictionary();
var headerParams: Dictionary = new Dictionary();
// verify required params are set
if() {
throw new ApiError(400, "missing required params");
}
var token:AsyncToken = getApiInvoker().invokeAPI(path, "GET", queryParams, null, headerParams);
var requestId: String = getUniqueId();
token.requestId = requestId;
token.completionEventType = "get_pet_by_id_in_object";
token.returnType = InlineResponse200;
return requestId;
}
/*
* Returns String
*/
public function pet_pet_idtesting_byte_arraytrue_get (petId: Number): String {
// create path and map variables
var path: String = "/pet/{petId}?testing_byte_array=true".replace(/{format}/g,"xml").replace("{" + "petId" + "}", getApiInvoker().escapeString(petId));
// query params
var queryParams: Dictionary = new Dictionary();
var headerParams: Dictionary = new Dictionary();
// verify required params are set
if() {
throw new ApiError(400, "missing required params");
}
var token:AsyncToken = getApiInvoker().invokeAPI(path, "GET", queryParams, null, headerParams);
var requestId: String = getUniqueId();
token.requestId = requestId;
token.completionEventType = "pet_pet_idtesting_byte_arraytrue_get";
token.returnType = String;
return requestId;
}
/*
* Returns void
*/
@ -320,7 +227,7 @@ public class PetApi extends SwaggerApi {
/*
* Returns void
*/
public function update_pet_with_form (petId: String, name: String, status: String): String {
public function update_pet_with_form (petId: Number, name: String, status: String): String {
// create path and map variables
var path: String = "/pet/{petId}".replace(/{format}/g,"xml").replace("{" + "petId" + "}", getApiInvoker().escapeString(petId));
@ -356,7 +263,7 @@ public class PetApi extends SwaggerApi {
}
/*
* Returns void
* Returns ApiResponse
*/
public function upload_file (petId: Number, additionalMetadata: String, file: File): String {
// create path and map variables
@ -388,7 +295,7 @@ public class PetApi extends SwaggerApi {
token.requestId = requestId;
token.completionEventType = "upload_file";
token.returnType = null ;
token.returnType = ApiResponse;
return requestId;
}

63
samples/client/petstore/flash/flash/src/io/swagger/client/api/StoreApi.as
View File

@ -7,7 +7,6 @@ import io.swagger.common.ApiUserCredentials;
import io.swagger.event.Response;
import io.swagger.common.SwaggerApi;
import io.swagger.client.model.Order;
import io.swagger.client.model.Object;
import mx.rpc.AsyncToken;
import mx.utils.UIDUtil;
@ -25,9 +24,7 @@ public class StoreApi extends SwaggerApi {
}
public static const event_delete_order: String = "delete_order";
public static const event_find_orders_by_status: String = "find_orders_by_status";
public static const event_get_inventory: String = "get_inventory";
public static const event_get_inventory_in_object: String = "get_inventory_in_object";
public static const event_get_order_by_id: String = "get_order_by_id";
public static const event_place_order: String = "place_order";
@ -62,38 +59,6 @@ public class StoreApi extends SwaggerApi {
}
/*
* Returns Array
*/
public function find_orders_by_status (status: String): String {
// create path and map variables
var path: String = "/store/findByStatus".replace(/{format}/g,"xml");
// query params
var queryParams: Dictionary = new Dictionary();
var headerParams: Dictionary = new Dictionary();
// verify required params are set
if() {
throw new ApiError(400, "missing required params");
}
if("null" != String(status))
queryParams["status"] = toPathValue(status);
var token:AsyncToken = getApiInvoker().invokeAPI(path, "GET", queryParams, null, headerParams);
var requestId: String = getUniqueId();
token.requestId = requestId;
token.completionEventType = "find_orders_by_status";
token.returnType = Array;
return requestId;
}
/*
* Returns Dictionary
*/
@ -120,36 +85,10 @@ public class StoreApi extends SwaggerApi {
}
/*
* Returns Object
*/
public function get_inventory_in_object (): String {
// create path and map variables
var path: String = "/store/inventory?response=arbitrary_object".replace(/{format}/g,"xml");
// query params
var queryParams: Dictionary = new Dictionary();
var headerParams: Dictionary = new Dictionary();
var token:AsyncToken = getApiInvoker().invokeAPI(path, "GET", queryParams, null, headerParams);
var requestId: String = getUniqueId();
token.requestId = requestId;
token.completionEventType = "get_inventory_in_object";
token.returnType = Object;
return requestId;
}
/*
* Returns Order
*/
public function get_order_by_id (orderId: String): String {
public function get_order_by_id (orderId: Number): String {
// create path and map variables
var path: String = "/store/order/{orderId}".replace(/{format}/g,"xml").replace("{" + "orderId" + "}", getApiInvoker().escapeString(orderId));

81
samples/dynamic-html/docs/index.html
View File

@ -29,82 +29,47 @@
<li>Getting Started</li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/UserApi">UserApi</a>
</div>
<ul>
<li><a href="#!/UserApi#createUser">createUser</a></li>
<li><a href="#!/UserApi#createUsersWithArrayInput">createUsersWithArrayInput</a></li>
<li><a href="#!/UserApi#createUsersWithListInput">createUsersWithListInput</a></li>
<li><a href="#!/UserApi#loginUser">loginUser</a></li>
<li><a href="#!/UserApi#logoutUser">logoutUser</a></li>
<li><a href="#!/UserApi#getUserByName">getUserByName</a></li>
<li><a href="#!/UserApi#updateUser">updateUser</a></li>
<li><a href="#!/UserApi#deleteUser">deleteUser</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/PetApi">PetApi</a>
</div>
<ul>
<li><a href="#!/PetApi#updatePet">updatePet</a></li>
<li><a href="#!/PetApi#addPet">addPet</a></li>
<li><a href="#!/PetApi#findPetsByStatus">findPetsByStatus</a></li>
<li><a href="#!/PetApi#findPetsByTags">findPetsByTags</a></li>
<li><a href="#!/PetApi#getPetById">getPetById</a></li>
<li><a href="#!/PetApi#updatePetWithForm">updatePetWithForm</a></li>
<li><a href="#!/PetApi#deletePet">deletePet</a></li>
<li><a href="#!/PetApi#findPetsByStatus">findPetsByStatus</a></li>
<li><a href="#!/PetApi#findPetsByTags">findPetsByTags</a></li>
<li><a href="#!/PetApi#getPetById">getPetById</a></li>
<li><a href="#!/PetApi#updatePet">updatePet</a></li>
<li><a href="#!/PetApi#updatePetWithForm">updatePetWithForm</a></li>
<li><a href="#!/PetApi#uploadFile">uploadFile</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/StoreApi">StoreApi</a>
</div>
<ul>
<li><a href="#!/StoreApi#getInventory">getInventory</a></li>
<li><a href="#!/StoreApi#placeOrder">placeOrder</a></li>
<li><a href="#!/StoreApi#getOrderById">getOrderById</a></li>
<li><a href="#!/StoreApi#deleteOrder">deleteOrder</a></li>
<li><a href="#!/StoreApi#getInventory">getInventory</a></li>
<li><a href="#!/StoreApi#getOrderById">getOrderById</a></li>
<li><a href="#!/StoreApi#placeOrder">placeOrder</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/UserApi">UserApi</a>
</div>
<ul>
<li><a href="#!/UserApi#createUser">createUser</a></li>
<li><a href="#!/UserApi#createUsersWithArrayInput">createUsersWithArrayInput</a></li>
<li><a href="#!/UserApi#createUsersWithListInput">createUsersWithListInput</a></li>
<li><a href="#!/UserApi#deleteUser">deleteUser</a></li>
<li><a href="#!/UserApi#getUserByName">getUserByName</a></li>
<li><a href="#!/UserApi#loginUser">loginUser</a></li>
<li><a href="#!/UserApi#logoutUser">logoutUser</a></li>
<li><a href="#!/UserApi#updateUser">updateUser</a></li>
</ul>
</div>
</div>
<div class="non-sidebar">
<div class="main-content">

5
samples/dynamic-html/docs/models/Category.html
View File

@ -1,17 +1,12 @@
<h2>Category</h2>
<ul class="parameter">
<li class="param-required-">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">name : String
<br/>
</li>
</ul>

18
samples/dynamic-html/docs/models/Order.html
View File

@ -1,57 +1,39 @@
<h2>Order</h2>
<ul class="parameter">
<li class="param-required-">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">petId : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">quantity : Integer
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">shipDate : Date
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">status : String
<br/>Order Status
<dl class="param-enum">
<dt>Enum:
<dd>placed</dd>
<dd>approved</dd>
<dd>delivered</dd>
</dt>
</dl>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">complete : Boolean
<br/>
</li>
</ul>

18
samples/dynamic-html/docs/models/Pet.html
View File

@ -1,57 +1,39 @@
<h2>Pet</h2>
<ul class="parameter">
<li class="param-required-">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">category : Category
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-true">name : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-true">photoUrls : List
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">tags : List
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">status : String
<br/>pet status in the store
<dl class="param-enum">
<dt>Enum:
<dd>available</dd>
<dd>pending</dd>
<dd>sold</dd>
</dt>
</dl>
</li>
</ul>

5
samples/dynamic-html/docs/models/Tag.html
View File

@ -1,17 +1,12 @@
<h2>Tag</h2>
<ul class="parameter">
<li class="param-required-">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">name : String
<br/>
</li>
</ul>

17
samples/dynamic-html/docs/models/User.html
View File

@ -1,59 +1,42 @@
<h2>User</h2>
<ul class="parameter">
<li class="param-required-">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">username : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">firstName : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">lastName : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">email : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">password : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">phone : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-">userStatus : Integer
<br/>User Status
</li>
</ul>

320
samples/dynamic-html/docs/operations/PetApi.html
View File

@ -2,35 +2,6 @@
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="updatePet"></a>updatePet</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">Pet</span>
<p class="param-description">Pet object that needs to be added to the store</p>
</li>
</ul>
<h2><a name="addPet"></a>addPet</h2>
<hr>
<p></p>
@ -43,7 +14,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -51,145 +21,11 @@
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">Pet</span>
<span class="param-type">Pet(Pet)</span>
<p class="param-description">Pet object that needs to be added to the store</p>
</li>
</ul>
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
<hr>
<p></p>
<p>Multiple status values can be provided with comma seperated strings</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/findByStatus</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">status</span>
<span class="param-type">List(String)</span>
<p class="param-description">Status values that need to be considered for filter</p>
</li>
</ul>
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
<hr>
<p></p>
<p>Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/findByTags</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">tags</span>
<span class="param-type">List(String)</span>
<p class="param-description">Tags to filter by</p>
</li>
</ul>
<h2><a name="getPetById"></a>getPetById</h2>
<hr>
<p></p>
<p>Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">Pet</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">petId</span>
<span class="param-type">Long</span>
<p class="param-description">ID of pet that needs to be fetched</p>
</li>
</ul>
<h2><a name="updatePetWithForm"></a>updatePetWithForm</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">petId</span>
<span class="param-type">String</span>
<p class="param-description">ID of pet that needs to be updated</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
<span class="param-name">name</span>
<span class="param-type">String</span>
<p class="param-description">Updated name of the pet</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
<span class="param-name">status</span>
<span class="param-type">String</span>
<p class="param-description">Updated status of the pet</p>
</li>
</ul>
<h2><a name="deletePet"></a>deletePet</h2>
<hr>
<p></p>
@ -202,7 +38,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -214,7 +49,6 @@
<p class="param-description">Pet id to delete</p>
</li>
<li class="parameter">
@ -226,9 +60,149 @@
<p class="param-description"></p>
</li>
</ul>
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
<hr>
<p></p>
<p>Multiple status values can be provided with comma separated strings</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/findByStatus</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">status</span>
<span class="param-type">List(String)</span>
<p class="param-description">Status values that need to be considered for filter</p>
</li>
</ul>
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
<hr>
<p></p>
<p>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/findByTags</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">tags</span>
<span class="param-type">List(String)</span>
<p class="param-description">Tags to filter by</p>
</li>
</ul>
<h2><a name="getPetById"></a>getPetById</h2>
<hr>
<p></p>
<p>Returns a single pet</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Pet"><a href="">Pet</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">petId</span>
<span class="param-type">Long</span>
<p class="param-description">ID of pet to return</p>
</li>
</ul>
<h2><a name="updatePet"></a>updatePet</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">Pet(Pet)</span>
<p class="param-description">Pet object that needs to be added to the store</p>
</li>
</ul>
<h2><a name="updatePetWithForm"></a>updatePetWithForm</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">petId</span>
<span class="param-type">Long</span>
<p class="param-description">ID of pet that needs to be updated</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
<span class="param-name">name</span>
<span class="param-type">String</span>
<p class="param-description">Updated name of the pet</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
<span class="param-name">status</span>
<span class="param-type">String</span>
<p class="param-description">Updated status of the pet</p>
</li>
</ul>
<h2><a name="uploadFile"></a>uploadFile</h2>
<hr>
<p></p>
@ -238,10 +212,9 @@
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<div class="model" data-model="ApiResponse"><a href="">ApiResponse</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -253,7 +226,6 @@
<p class="param-description">ID of pet to update</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
@ -265,7 +237,6 @@
<p class="param-description">Additional data to pass to server</p>
</li>
<li class="parameter">
<span class="param-in">Form: </span>
@ -277,8 +248,5 @@
<p class="param-description">file to upload</p>
</li>
</ul>
</div>

136
samples/dynamic-html/docs/operations/StoreApi.html
View File

@ -2,77 +2,6 @@
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="getInventory"></a>getInventory</h2>
<hr>
<p></p>
<p>Returns a map of status codes to quantities</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/inventory</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="integer"><a href="">Map</a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="placeOrder"></a>placeOrder</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/order</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Order"><a href="">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">Order</span>
<p class="param-description">order placed for purchasing the pet</p>
</li>
</ul>
<h2><a name="getOrderById"></a>getOrderById</h2>
<hr>
<p></p>
<p>For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/order/{orderId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Order"><a href="">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">orderId</span>
<span class="param-type">String</span>
<p class="param-description">ID of pet that needs to be fetched</p>
</li>
</ul>
<h2><a name="deleteOrder"></a>deleteOrder</h2>
<hr>
<p></p>
@ -85,7 +14,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -97,8 +25,66 @@
<p class="param-description">ID of the order that needs to be deleted</p>
</li>
</ul>
<h2><a name="getInventory"></a>getInventory</h2>
<hr>
<p></p>
<p>Returns a map of status codes to quantities</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/inventory</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="integer"><a href="">Map</a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="getOrderById"></a>getOrderById</h2>
<hr>
<p></p>
<p>For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/order/{orderId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Order"><a href="">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">orderId</span>
<span class="param-type">Long</span>
<p class="param-description">ID of pet that needs to be fetched</p>
</li>
</ul>
<h2><a name="placeOrder"></a>placeOrder</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/store/order</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="Order"><a href="">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">Order(Order)</span>
<p class="param-description">order placed for purchasing the pet</p>
</li>
</ul>
</div>

248
samples/dynamic-html/docs/operations/UserApi.html
View File

@ -2,8 +2,6 @@
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="createUser"></a>createUser</h2>
<hr>
<p></p>
@ -16,7 +14,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -24,13 +21,11 @@
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">User</span>
<span class="param-type">User(User)</span>
<p class="param-description">Created user object</p>
</li>
</ul>
<h2><a name="createUsersWithArrayInput"></a>createUsersWithArrayInput</h2>
<hr>
<p></p>
@ -43,7 +38,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -51,13 +45,11 @@
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">List</span>
<span class="param-type">List(User)</span>
<p class="param-description">List of user object</p>
</li>
</ul>
<h2><a name="createUsersWithListInput"></a>createUsersWithListInput</h2>
<hr>
<p></p>
@ -70,7 +62,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -78,133 +69,11 @@
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">List</span>
<span class="param-type">List(User)</span>
<p class="param-description">List of user object</p>
</li>
</ul>
<h2><a name="loginUser"></a>loginUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/login</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="string"><a href="">String</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">The user name for login</p>
</li>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">password</span>
<span class="param-type">String</span>
<p class="param-description">The password for login in clear text</p>
</li>
</ul>
<h2><a name="logoutUser"></a>logoutUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/logout</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="getUserByName"></a>getUserByName</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="User"><a href="">User</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">The name that needs to be fetched. Use user1 for testing.</p>
</li>
</ul>
<h2><a name="updateUser"></a>updateUser</h2>
<hr>
<p></p>
<p>This can only be done by the logged in user.</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">name that need to be deleted</p>
</li>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">User</span>
<p class="param-description">Updated user object</p>
</li>
</ul>
<h2><a name="deleteUser"></a>deleteUser</h2>
<hr>
<p></p>
@ -217,7 +86,6 @@
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@ -229,8 +97,112 @@
<p class="param-description">The name that needs to be deleted</p>
</li>
</ul>
<h2><a name="getUserByName"></a>getUserByName</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="User"><a href="">User</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">The name that needs to be fetched. Use user1 for testing. </p>
</li>
</ul>
<h2><a name="loginUser"></a>loginUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/login</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model="string"><a href="">String</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">The user name for login</p>
</li>
<li class="parameter">
<span class="param-in">Query: </span>
<span class="param-name">password</span>
<span class="param-type">String</span>
<p class="param-description">The password for login in clear text</p>
</li>
</ul>
<h2><a name="logoutUser"></a>logoutUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/logout</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="updateUser"></a>updateUser</h2>
<hr>
<p></p>
<p>This can only be done by the logged in user.</p>
<h3 class="section">URL</h3>
<code>http://petstore.swagger.io/v2/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
<span class="param-in">Path: </span>
<span class="param-name">username</span>
<span class="param-type">String</span>
<p class="param-description">name that need to be deleted</p>
</li>
<li class="parameter">
<span class="param-in">Body: </span>
<span class="param-name">body</span>
<span class="param-type">User(User)</span>
<p class="param-description">Updated user object</p>
</li>
</ul>
</div>

419
samples/html/index.html
View File

@ -182,7 +182,7 @@ font-style: italic;
</head>
<body>
<h1>Swagger Petstore</h1>
<div class="app-desc">This is a sample server Petstore server. You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters</div>
<div class="app-desc">This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.</div>
<div class="app-desc">Contact Info: <a href="apiteam@swagger.io">apiteam@swagger.io</a></div>
<div class="app-desc">Version: 1.0.0</div>
@ -198,20 +198,15 @@ font-style: italic;
<div class="method-summary"></div>
<ol>
<li><a href="#addPet"><code><span class="http-method">post</span> /pet</code></a></li>
<li><a href="#addPetUsingByteArray"><code><span class="http-method">post</span> /pet?testing_byte_array&#x3D;true</code></a></li>
<li><a href="#deletePet"><code><span class="http-method">delete</span> /pet/{petId}</code></a></li>
<li><a href="#findPetsByStatus"><code><span class="http-method">get</span> /pet/findByStatus</code></a></li>
<li><a href="#findPetsByTags"><code><span class="http-method">get</span> /pet/findByTags</code></a></li>
<li><a href="#getPetById"><code><span class="http-method">get</span> /pet/{petId}</code></a></li>
<li><a href="#getPetByIdInObject"><code><span class="http-method">get</span> /pet/{petId}?response&#x3D;inline_arbitrary_object</code></a></li>
<li><a href="#petPetIdtestingByteArraytrueGet"><code><span class="http-method">get</span> /pet/{petId}?testing_byte_array&#x3D;true</code></a></li>
<li><a href="#updatePet"><code><span class="http-method">put</span> /pet</code></a></li>
<li><a href="#updatePetWithForm"><code><span class="http-method">post</span> /pet/{petId}</code></a></li>
<li><a href="#uploadFile"><code><span class="http-method">post</span> /pet/{petId}/uploadImage</code></a></li>
<li><a href="#deleteOrder"><code><span class="http-method">delete</span> /store/order/{orderId}</code></a></li>
<li><a href="#findOrdersByStatus"><code><span class="http-method">get</span> /store/findByStatus</code></a></li>
<li><a href="#getInventory"><code><span class="http-method">get</span> /store/inventory</code></a></li>
<li><a href="#getInventoryInObject"><code><span class="http-method">get</span> /store/inventory?response&#x3D;arbitrary_object</code></a></li>
<li><a href="#getOrderById"><code><span class="http-method">get</span> /store/order/{orderId}</code></a></li>
<li><a href="#placeOrder"><code><span class="http-method">post</span> /store/order</code></a></li>
<li><a href="#createUser"><code><span class="http-method">post</span> /user</code></a></li>
@ -241,7 +236,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Pet object that needs to be added to the store </div>
</div> <!-- field-items -->
@ -257,50 +252,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">405</h4>
Invalid input
</div> <!-- method -->
<hr/>
<div class="method"><a name="addPetUsingByteArray"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /pet?testing_byte_array&#x3D;true</code></pre></div>
<div class="method-summary">Fake endpoint to test byte array in body parameter for adding a new pet to the store (<span class="nickname">addPetUsingByteArray</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Pet object in the form of byte array </div>
</div> <!-- field-items -->
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -335,8 +288,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -357,9 +310,9 @@ font-style: italic;
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">status (optional)</div>
<div class="param">status (required)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Status values that need to be considered for query default: available</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Status values that need to be considered for filter </div>
</div> <!-- field-items -->
@ -376,8 +329,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -392,7 +345,7 @@ font-style: italic;
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /pet/findByTags</code></pre></div>
<div class="method-summary">Finds Pets by tags (<span class="nickname">findPetsByTags</span>)</div>
<div class="method-notes">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div>
<div class="method-notes">Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</div>
@ -400,7 +353,7 @@ font-style: italic;
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">tags (optional)</div>
<div class="param">tags (required)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Tags to filter by </div>
</div> <!-- field-items -->
@ -419,8 +372,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -435,13 +388,13 @@ font-style: italic;
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /pet/{petId}</code></pre></div>
<div class="method-summary">Find pet by ID (<span class="nickname">getPetById</span>)</div>
<div class="method-notes">Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions</div>
<div class="method-notes">Returns a single pet</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">petId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; ID of pet that needs to be fetched </div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; ID of pet to return </div>
</div> <!-- field-items -->
@ -462,98 +415,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<h4 class="field-label">400</h4>
Invalid ID supplied
<h4 class="field-label">404</h4>
Pet not found
</div> <!-- method -->
<hr/>
<div class="method"><a name="getPetByIdInObject"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /pet/{petId}?response&#x3D;inline_arbitrary_object</code></pre></div>
<div class="method-summary">Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39; (<span class="nickname">getPetByIdInObject</span>)</div>
<div class="method-notes">Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">petId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; ID of pet that needs to be fetched </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#inline_response_200">inline_response_200</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<h4 class="field-label">400</h4>
Invalid ID supplied
<h4 class="field-label">404</h4>
Pet not found
</div> <!-- method -->
<hr/>
<div class="method"><a name="petPetIdtestingByteArraytrueGet"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /pet/{petId}?testing_byte_array&#x3D;true</code></pre></div>
<div class="method-summary">Fake endpoint to test byte array return by &#39;Find pet by ID&#39; (<span class="nickname">petPetIdtestingByteArraytrueGet</span>)</div>
<div class="method-notes">Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">petId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; ID of pet that needs to be fetched </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
byte[]
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -582,7 +445,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Pet object that needs to be added to the store </div>
</div> <!-- field-items -->
@ -598,8 +461,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -651,8 +514,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -692,6 +555,11 @@ font-style: italic;
<div class="param-desc"><span class="param-type">Form Parameter</span> &mdash; file to upload </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#ApiResponse">ApiResponse</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
@ -701,11 +569,10 @@ font-style: italic;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">0</h4>
<h4 class="field-label">200</h4>
successful operation
</div> <!-- method -->
<hr/>
@ -736,8 +603,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -747,49 +614,6 @@ font-style: italic;
Order not found
</div> <!-- method -->
<hr/>
<div class="method"><a name="findOrdersByStatus"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /store/findByStatus</code></pre></div>
<div class="method-summary">Finds orders by status (<span class="nickname">findOrdersByStatus</span>)</div>
<div class="method-notes">A single status value can be provided as a string</div>
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">status (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Status value that needs to be considered for query default: placed</div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
array[<a href="#Order">Order</a>]
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<h4 class="field-label">400</h4>
Invalid status value
</div> <!-- method -->
<hr/>
<div class="method"><a name="getInventory"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
@ -817,42 +641,6 @@ font-style: italic;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
</div> <!-- method -->
<hr/>
<div class="method"><a name="getInventoryInObject"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /store/inventory?response&#x3D;arbitrary_object</code></pre></div>
<div class="method-summary">Fake endpoint to test arbitrary object return by &#39;Get inventory&#39; (<span class="nickname">getInventoryInObject</span>)</div>
<div class="method-notes">Returns an arbitrary object which is actually a map of status codes to quantities</div>
<h3 class="field-label">Return type</h3>
<div class="return-type">
Object
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -892,8 +680,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -916,7 +704,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; order placed for purchasing the pet </div>
</div> <!-- field-items -->
@ -937,8 +725,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -959,7 +747,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Created user object </div>
</div> <!-- field-items -->
@ -975,8 +763,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -995,7 +783,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; List of user object </div>
</div> <!-- field-items -->
@ -1011,8 +799,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1031,7 +819,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; List of user object </div>
</div> <!-- field-items -->
@ -1047,8 +835,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1083,8 +871,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1126,16 +914,13 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{id&#x3D;1, username&#x3D;johnp, firstName&#x3D;John, lastName&#x3D;Public, email&#x3D;johnp@swagger.io, password&#x3D;-secret-, phone&#x3D;0123456789, userStatus&#x3D;0}</code></pre>
<h4 class="field-label">400</h4>
Invalid username supplied
<h4 class="field-label">404</h4>
@ -1155,9 +940,9 @@ font-style: italic;
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">username (optional)</div>
<div class="param">username (required)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The user name for login </div><div class="param">password (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The user name for login </div><div class="param">password (required)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The password for login in clear text </div>
</div> <!-- field-items -->
@ -1176,8 +961,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1208,8 +993,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1234,7 +1019,7 @@ font-style: italic;
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (optional)</div>
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Updated user object </div>
</div> <!-- field-items -->
@ -1250,8 +1035,8 @@ font-style: italic;
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
@ -1268,147 +1053,73 @@ font-style: italic;
<h2>Table of Contents</h2>
<ol>
<li><a href="#$special[model.name]"><code>$special[model.name]</code></a></li>
<li><a href="#200_response"><code>200_response</code></a></li>
<li><a href="#Animal"><code>Animal</code></a></li>
<li><a href="#Cat"><code>Cat</code></a></li>
<li><a href="#ApiResponse"><code>ApiResponse</code></a></li>
<li><a href="#Category"><code>Category</code></a></li>
<li><a href="#Dog"><code>Dog</code></a></li>
<li><a href="#Format_test"><code>Format_test</code></a></li>
<li><a href="#Inline_response_200"><code>Inline_response_200</code></a></li>
<li><a href="#Name"><code>Name</code></a></li>
<li><a href="#Order"><code>Order</code></a></li>
<li><a href="#Pet"><code>Pet</code></a></li>
<li><a href="#Return"><code>Return</code></a></li>
<li><a href="#Tag"><code>Tag</code></a></li>
<li><a href="#User"><code>User</code></a></li>
</ol>
<div class="model">
<h3 class="field-label"><a name="$special[model.name]">$special[model.name]</a> <a class="up" href="#__Models">Up</a></h3>
<h3 class="field-label"><a name="ApiResponse">ApiResponse</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">$special[property.name] </div><div class="param-desc"><span class="param-type">Long</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="200_response">200_response</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">name </div><div class="param-desc"><span class="param-type">Integer</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Animal">Animal</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">className </div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Cat">Cat</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">className </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">declawed </div><div class="param-desc"><span class="param-type">Boolean</span> </div>
<div class="param">code (optional)</div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Category">Category</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">name </div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Dog">Dog</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">className </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">breed </div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Format_test">Format_test</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">integer </div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">int32 </div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">int64 </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">number </div><div class="param-desc"><span class="param-type">BigDecimal</span> </div>
<div class="param">float </div><div class="param-desc"><span class="param-type">Float</span> </div>
<div class="param">double </div><div class="param-desc"><span class="param-type">Double</span> </div>
<div class="param">string </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">byte </div><div class="param-desc"><span class="param-type">byte[]</span> </div>
<div class="param">binary </div><div class="param-desc"><span class="param-type">byte[]</span> </div>
<div class="param">date </div><div class="param-desc"><span class="param-type">date</span> </div>
<div class="param">dateTime </div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Inline_response_200">Inline_response_200</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">tags </div><div class="param-desc"><span class="param-type">array[Tag]</span> </div>
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">category </div><div class="param-desc"><span class="param-type">Object</span> </div>
<div class="param">status </div><div class="param-desc"><span class="param-type">String</span> pet status in the store</div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">available</div><div class="param-enum">pending</div><div class="param-enum">sold</div>
<div class="param">name </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">photoUrls </div><div class="param-desc"><span class="param-type">array[String]</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Name">Name</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">name </div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">snake_case </div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Order">Order</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">petId </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">quantity </div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">shipDate </div><div class="param-desc"><span class="param-type">Date</span> </div>
<div class="param">status </div><div class="param-desc"><span class="param-type">String</span> Order Status</div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">petId (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">quantity (optional)</div><div class="param-desc"><span class="param-type">Integer</span> </div>
<div class="param">shipDate (optional)</div><div class="param-desc"><span class="param-type">Date</span> </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type">String</span> Order Status</div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">placed</div><div class="param-enum">approved</div><div class="param-enum">delivered</div>
<div class="param">complete </div><div class="param-desc"><span class="param-type">Boolean</span> </div>
<div class="param">complete (optional)</div><div class="param-desc"><span class="param-type">Boolean</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Pet">Pet</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">category </div><div class="param-desc"><span class="param-type">Category</span> </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">category (optional)</div><div class="param-desc"><span class="param-type">Category</span> </div>
<div class="param">name </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">photoUrls </div><div class="param-desc"><span class="param-type">array[String]</span> </div>
<div class="param">tags </div><div class="param-desc"><span class="param-type">array[Tag]</span> </div>
<div class="param">status </div><div class="param-desc"><span class="param-type">String</span> pet status in the store</div>
<div class="param">tags (optional)</div><div class="param-desc"><span class="param-type">array[Tag]</span> </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type">String</span> pet status in the store</div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">available</div><div class="param-enum">pending</div><div class="param-enum">sold</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Return">Return</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">return </div><div class="param-desc"><span class="param-type">Integer</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="Tag">Tag</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">name </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="User">User</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id </div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">username </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">firstName </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">lastName </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">email </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">password </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">phone </div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">userStatus </div><div class="param-desc"><span class="param-type">Integer</span> User Status</div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type">Long</span> </div>
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">firstName (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">lastName (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">phone (optional)</div><div class="param-desc"><span class="param-type">String</span> </div>
<div class="param">userStatus (optional)</div><div class="param-desc"><span class="param-type">Integer</span> User Status</div>
</div> <!-- field-items -->
</div>
</body>