forked from loafle/openapi-generator-original
rebuilt
This commit is contained in:
Tony Tam
parent
dae01b5043
commit
0b2eced6a3
@ -18,8 +18,321 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="put"><code class="huge"><span>put</span>: /pet</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">updatePet</span> Update an existing pet</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">body (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — Pet object that needs to be added to the store </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">addPet</span> Add a new pet to the store</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">body (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — Pet object that needs to be added to the store </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/findByStatus</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">findPetsByStatus</span> Finds Pets by status</div>
|
||||||
|
<div class="method-notes">Multiple status values can be provided with comma seperated strings</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">status (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Status values that need to be considered for filter </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#array">array[Pet]</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>[ {\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n} ]</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/findByTags</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">findPetsByTags</span> Finds Pets by tags</div>
|
||||||
|
<div class="method-notes">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">tags (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Tags to filter by </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#array">array[Pet]</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>[ {\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n} ]</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/{petId}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">getPetById</span> Find pet by ID</div>
|
||||||
|
<div class="method-notes">Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">petId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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="#">Pet</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>{\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n}</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet/{petId}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">updatePetWithForm</span> Updates a pet in the store with form data</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">petId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of pet that needs to be updated </div>
|
||||||
|
<div class="param">name (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — Updated name of the pet </div>
|
||||||
|
<div class="param">status (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — Updated status of the pet </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /pet/{petId}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">deletePet</span> Deletes a pet</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">api_key (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Header Parameter</span> — </div>
|
||||||
|
<div class="param">petId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Pet id to delete </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet/{petId}/uploadImage</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Pet</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">uploadFile</span> uploads an image</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">petId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of pet to update </div>
|
||||||
|
<div class="param">additionalMetadata (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — Additional data to pass to server </div>
|
||||||
|
<div class="param">file (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — file to upload </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /store/inventory</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Store</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">getInventory</span> Returns pet inventories by status</div>
|
||||||
|
<div class="method-notes">Returns a map of status codes to quantities</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#map">map[String, Integer]</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>{\n "key" : 123\n}</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code>not implemented com.wordnik.swagger.models.properties.MapProperty@5076b51c</code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /store/order</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Store</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">placeOrder</span> Place an order for a pet</div>
|
||||||
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">body (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — order placed for purchasing the pet </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#">Order</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>{\n "id" : 123456789,\n "petId" : 123456789,\n "complete" : true,\n "status" : "aeiou",\n "quantity" : 123,\n "shipDate" : "2015-05-12T09:58:06.953+0000"\n}</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code><Order>\n <id>123456</id>\n <petId>123456</petId>\n <quantity>0</quantity>\n <shipDate>2015-05-12T05:58:06.956Z</shipDate>\n <status>string</status>\n <complete>true</complete>\n</Order></code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /store/order/{orderId}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Store</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">getOrderById</span> Find purchase order by ID</div>
|
||||||
|
<div class="method-notes">For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">orderId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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="#">Order</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||||
|
<pre class="example"><code>{\n "id" : 123456789,\n "petId" : 123456789,\n "complete" : true,\n "status" : "aeiou",\n "quantity" : 123,\n "shipDate" : "2015-05-12T09:58:06.957+0000"\n}</code></pre>
|
||||||
|
|
||||||
|
<h3 class="field-label">Example data</h3>
|
||||||
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
||||||
|
<pre class="example"><code><Order>\n <id>123456</id>\n <petId>123456</petId>\n <quantity>0</quantity>\n <shipDate>2015-05-12T05:58:06.957Z</shipDate>\n <status>string</status>\n <complete>true</complete>\n</Order></code></pre>
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<div class="method">
|
||||||
|
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /store/order/{orderId}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">Store</span></div>
|
||||||
|
<div class="method-summary"><span class="nickname">deleteOrder</span> Delete purchase order by ID</div>
|
||||||
|
<div class="method-notes">For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</div>
|
||||||
|
|
||||||
|
<h3 class="field-label">Parameters</h3>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">orderId (required)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of the order that needs to be deleted </div>
|
||||||
|
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
<h3 class="field-label">Return type</h3>
|
||||||
|
|
||||||
|
<div class="return-type"><a href="#"></a></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- method -->
|
||||||
|
<hr>
|
||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user</code></pre></div>
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">createUser</span> Create user</div>
|
<div class="method-summary"><span class="nickname">createUser</span> Create user</div>
|
||||||
<div class="method-notes">This can only be done by the logged in user.</div>
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
||||||
|
|
||||||
@ -40,6 +353,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user/createWithArray</code></pre></div>
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user/createWithArray</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">createUsersWithArrayInput</span> Creates list of users with given input array</div>
|
<div class="method-summary"><span class="nickname">createUsersWithArrayInput</span> Creates list of users with given input array</div>
|
||||||
<div class="method-notes"></div>
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
@ -60,6 +374,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user/createWithList</code></pre></div>
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user/createWithList</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">createUsersWithListInput</span> Creates list of users with given input array</div>
|
<div class="method-summary"><span class="nickname">createUsersWithListInput</span> Creates list of users with given input array</div>
|
||||||
<div class="method-notes"></div>
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
@ -80,6 +395,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/login</code></pre></div>
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/login</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">loginUser</span> Logs user into the system</div>
|
<div class="method-summary"><span class="nickname">loginUser</span> Logs user into the system</div>
|
||||||
<div class="method-notes"></div>
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
@ -111,6 +427,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/logout</code></pre></div>
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/logout</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">logoutUser</span> Logs out current logged in user session</div>
|
<div class="method-summary"><span class="nickname">logoutUser</span> Logs out current logged in user session</div>
|
||||||
<div class="method-notes"></div>
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
@ -128,6 +445,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/{username}</code></pre></div>
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/{username}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">getUserByName</span> Get user by user name</div>
|
<div class="method-summary"><span class="nickname">getUserByName</span> Get user by user name</div>
|
||||||
<div class="method-notes"></div>
|
<div class="method-notes"></div>
|
||||||
|
|
||||||
@ -156,6 +474,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="put"><code class="huge"><span>put</span>: /user/{username}</code></pre></div>
|
<div class="method-path"><pre class="put"><code class="huge"><span>put</span>: /user/{username}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">updateUser</span> Updated user</div>
|
<div class="method-summary"><span class="nickname">updateUser</span> Updated user</div>
|
||||||
<div class="method-notes">This can only be done by the logged in user.</div>
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
||||||
|
|
||||||
@ -179,6 +498,7 @@
|
|||||||
|
|
||||||
<div class="method">
|
<div class="method">
|
||||||
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /user/{username}</code></pre></div>
|
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /user/{username}</code></pre></div>
|
||||||
|
<div class="method-tags"> <span class="method-tag">User</span></div>
|
||||||
<div class="method-summary"><span class="nickname">deleteUser</span> Delete user</div>
|
<div class="method-summary"><span class="nickname">deleteUser</span> Delete user</div>
|
||||||
<div class="method-notes">This can only be done by the logged in user.</div>
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
||||||
|
|
||||||
@ -198,310 +518,6 @@
|
|||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="put"><code class="huge"><span>put</span>: /pet</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">updatePet</span> Update an existing pet</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">body (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Body Parameter</span> — Pet object that needs to be added to the store </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">addPet</span> Add a new pet to the store</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">body (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Body Parameter</span> — Pet object that needs to be added to the store </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/findByStatus</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">findPetsByStatus</span> Finds Pets by status</div>
|
|
||||||
<div class="method-notes">Multiple status values can be provided with comma seperated strings</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">status (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — Status values that need to be considered for filter </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#array">array[Pet]</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>[ {\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n} ]</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/findByTags</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">findPetsByTags</span> Finds Pets by tags</div>
|
|
||||||
<div class="method-notes">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">tags (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — Tags to filter by </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#array">array[Pet]</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>[ {\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n} ]</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /pet/{petId}</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">getPetById</span> Find pet by ID</div>
|
|
||||||
<div class="method-notes">Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">petId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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="#">Pet</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>{\n "tags" : [ {\n "id" : 123456789,\n "name" : "aeiou"\n } ],\n "id" : 123456789,\n "category" : {\n "id" : 123456789,\n "name" : "aeiou"\n },\n "status" : "aeiou",\n "name" : "doggie",\n "photoUrls" : [ "aeiou" ]\n}</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code><Pet>\n <id>123456</id>\n <Category>\n <id>123456</id>\n <name>string</name>\n </Category>\n <name>doggie</name>\n <photoUrls>string</photoUrls>\n <Tag>\n <id>123456</id>\n <name>string</name>\n </Tag>\n <status>string</status>\n</Pet></code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet/{petId}</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">updatePetWithForm</span> Updates a pet in the store with form data</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">petId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of pet that needs to be updated </div>
|
|
||||||
<div class="param">name (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Form Parameter</span> — Updated name of the pet </div>
|
|
||||||
<div class="param">status (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Form Parameter</span> — Updated status of the pet </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /pet/{petId}</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">deletePet</span> Deletes a pet</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">api_key (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Header Parameter</span> — </div>
|
|
||||||
<div class="param">petId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — Pet id to delete </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /pet/{petId}/uploadImage</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">uploadFile</span> uploads an image</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">petId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of pet to update </div>
|
|
||||||
<div class="param">additionalMetadata (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Form Parameter</span> — Additional data to pass to server </div>
|
|
||||||
<div class="param">file (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Form Parameter</span> — file to upload </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /store/inventory</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">getInventory</span> Returns pet inventories by status</div>
|
|
||||||
<div class="method-notes">Returns a map of status codes to quantities</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#map">map[String, Integer]</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>{\n "key" : 123\n}</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code>not implemented com.wordnik.swagger.models.properties.MapProperty@3c536f11</code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /store/order</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">placeOrder</span> Place an order for a pet</div>
|
|
||||||
<div class="method-notes"></div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">body (optional)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Body Parameter</span> — order placed for purchasing the pet </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#">Order</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>{\n "id" : 123456789,\n "petId" : 123456789,\n "complete" : true,\n "status" : "aeiou",\n "quantity" : 123,\n "shipDate" : "2015-04-16T14:41:29.883+0000"\n}</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code><Order>\n <id>123456</id>\n <petId>123456</petId>\n <quantity>0</quantity>\n <shipDate>2015-04-16T22:41:29.886Z</shipDate>\n <status>string</status>\n <complete>true</complete>\n</Order></code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /store/order/{orderId}</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">getOrderById</span> Find purchase order by ID</div>
|
|
||||||
<div class="method-notes">For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">orderId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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="#">Order</a></div>
|
|
||||||
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
||||||
<pre class="example"><code>{\n "id" : 123456789,\n "petId" : 123456789,\n "complete" : true,\n "status" : "aeiou",\n "quantity" : 123,\n "shipDate" : "2015-04-16T14:41:29.887+0000"\n}</code></pre>
|
|
||||||
|
|
||||||
<h3 class="field-label">Example data</h3>
|
|
||||||
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
||||||
<pre class="example"><code><Order>\n <id>123456</id>\n <petId>123456</petId>\n <quantity>0</quantity>\n <shipDate>2015-04-16T22:41:29.888Z</shipDate>\n <status>string</status>\n <complete>true</complete>\n</Order></code></pre>
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div class="method">
|
|
||||||
<div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /store/order/{orderId}</code></pre></div>
|
|
||||||
<div class="method-summary"><span class="nickname">deleteOrder</span> Delete purchase order by ID</div>
|
|
||||||
<div class="method-notes">For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</div>
|
|
||||||
|
|
||||||
<h3 class="field-label">Parameters</h3>
|
|
||||||
<div class="field-items">
|
|
||||||
<div class="param">orderId (required)</div>
|
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — ID of the order that needs to be deleted </div>
|
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
|
||||||
<h3 class="field-label">Return type</h3>
|
|
||||||
|
|
||||||
<div class="return-type"><a href="#"></a></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- method -->
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Models</h2>
|
<h2>Models</h2>
|
||||||
|
|
||||||
@ -631,6 +647,7 @@ hr {
|
|||||||
|
|
||||||
pre {
|
pre {
|
||||||
padding: 10px;
|
padding: 10px;
|
||||||
|
margin-bottom: 2px;
|
||||||
}
|
}
|
||||||
|
|
||||||
pre.get {
|
pre.get {
|
||||||
@ -712,6 +729,19 @@ code {
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.method-tags {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-tag {
|
||||||
|
background: none repeat scroll 0% 0% #24A600;
|
||||||
|
border-radius: 3px;
|
||||||
|
padding: 2px 10px;
|
||||||
|
margin: 2px;
|
||||||
|
color: #FFF;
|
||||||
|
display: inline-block;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
</style>
|
</style>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
Loading…
x
Reference in New Issue
Block a user