mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-08 19:33:55 +00:00
717 lines
27 KiB
HTML
717 lines
27 KiB
HTML
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>API Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="site.css" media="screen" />
|
|
</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 for </div>
|
|
|
|
<div class="app-desc">Contact Info: <a href="apiteam@wordnik.com">apiteam@wordnik.com</a></div>
|
|
<div class="app-desc">Version: 1.0.0</div>
|
|
<div class="license-info">Apache 2.0</div>
|
|
<div class="license-url">http://www.apache.org/licenses/LICENSE-2.0.html</div>
|
|
<h2>Access</h2>
|
|
<div class="method-summary">Customize this message as you see fit!</div>
|
|
<h2>Methods</h2>
|
|
|
|
|
|
|
|
<div class="method">
|
|
<div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /user</code></pre></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>
|
|
|
|
<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> — Created user object </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>: /user/createWithArray</code></pre></div>
|
|
<div class="method-summary"><span class="nickname">createUsersWithArrayInput</span> Creates list of users with given input array</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> — List of user object </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>: /user/createWithList</code></pre></div>
|
|
<div class="method-summary"><span class="nickname">createUsersWithListInput</span> Creates list of users with given input array</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> — List of user object </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>: /user/login</code></pre></div>
|
|
<div class="method-summary"><span class="nickname">loginUser</span> Logs user into the system</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">username (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The user name for login </div>
|
|
<div class="param">password (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The password for login in clear text </div>
|
|
|
|
</div> <!-- field-items -->
|
|
<h3 class="field-label">Return type</h3>
|
|
|
|
<div class="return-type"><a href="#">String</a></div>
|
|
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>"aeiou"</code></pre>
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/xml</div>
|
|
<pre class="example"><code>string</code></pre>
|
|
|
|
</div> <!-- method -->
|
|
<hr>
|
|
|
|
<div class="method">
|
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/logout</code></pre></div>
|
|
<div class="method-summary"><span class="nickname">logoutUser</span> Logs out current logged in user session</div>
|
|
<div class="method-notes"></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="#"></a></div>
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr>
|
|
|
|
<div class="method">
|
|
<div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /user/{username}</code></pre></div>
|
|
<div class="method-summary"><span class="nickname">getUserByName</span> Get user by user name</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">username (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The name that needs to be fetched. Use user1 for testing. </div>
|
|
|
|
</div> <!-- field-items -->
|
|
<h3 class="field-label">Return type</h3>
|
|
|
|
<div class="return-type"><a href="#">User</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 "lastName" : "aeiou",\n "phone" : "aeiou",\n "username" : "aeiou",\n "email" : "aeiou",\n "userStatus" : 123,\n "firstName" : "aeiou",\n "password" : "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><User>\n <id>123456</id>\n <username>string</username>\n <firstName>string</firstName>\n <lastName>string</lastName>\n <email>string</email>\n <password>string</password>\n <phone>string</phone>\n <userStatus>0</userStatus>\n</User></code></pre>
|
|
|
|
</div> <!-- method -->
|
|
<hr>
|
|
|
|
<div class="method">
|
|
<div class="method-path"><pre class="put"><code class="huge"><span>put</span>: /user/{username}</code></pre></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>
|
|
|
|
<h3 class="field-label">Parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">username (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — name that need to be deleted </div>
|
|
<div class="param">body (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — Updated user object </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>: /user/{username}</code></pre></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>
|
|
|
|
<h3 class="field-label">Parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">username (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The name 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-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@2acca551</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-05T03:02:18.855+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-04T20:02:18.857Z</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-05T03:02:18.859+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-04T20:02:18.859Z</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>
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="User">User</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> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Category">Category</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="Pet">Pet</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">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> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Tag">Tag</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="Order">Order</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">complete </div><div class="param-desc"><span class="param-type">Boolean</span> </div>
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
<style>
|
|
body {
|
|
font-family: Trebuchet MS, sans-serif;
|
|
font-size: 15px;
|
|
color: #444;
|
|
margin-right: 24px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 25px;
|
|
}
|
|
h2 {
|
|
font-size: 20px;
|
|
}
|
|
h3 {
|
|
font-size: 16px;
|
|
font-weight: bold;
|
|
}
|
|
hr {
|
|
height: 1px;
|
|
border: 0;
|
|
color: #ddd;
|
|
background-color: #ddd;
|
|
display: none;
|
|
}
|
|
|
|
.app-desc {
|
|
clear: both;
|
|
margin-left: 20px;
|
|
}
|
|
.param-name {
|
|
width: 100%;
|
|
}
|
|
.license-info {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.license-url {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.model {
|
|
margin: 0 0 0px 20px;
|
|
}
|
|
|
|
.method {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.method-notes {
|
|
margin: 10px 0 20px 0;
|
|
font-size: 90%;
|
|
color: #555;
|
|
}
|
|
|
|
pre {
|
|
padding: 10px;
|
|
}
|
|
|
|
pre.get {
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
pre.post {
|
|
background-color: #10a54a;
|
|
}
|
|
|
|
pre.put {
|
|
background-color: #c5862b;
|
|
}
|
|
|
|
pre.delete {
|
|
background-color: #a41e22;
|
|
}
|
|
|
|
.huge {
|
|
color: #fff;
|
|
}
|
|
|
|
pre.example {
|
|
background-color: #f3f3f3;
|
|
padding: 10px;
|
|
border: 1px solid #ddd;
|
|
}
|
|
|
|
code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.nickname {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-path {
|
|
font-size: 1.5em;
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
.parameter {
|
|
width: 500px;
|
|
}
|
|
|
|
.param {
|
|
width: 500px;
|
|
padding: 10px 0 0 20px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-desc {
|
|
width: 700px;
|
|
padding: 0 0 0 20px;
|
|
color: #777;
|
|
}
|
|
|
|
.param-type {
|
|
font-style: italic;
|
|
}
|
|
|
|
.field-label {
|
|
padding: 0;
|
|
margin: 0;
|
|
clear: both;
|
|
}
|
|
|
|
.field-items {
|
|
padding: 0 0 15px 0;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.return-type {
|
|
clear: both;
|
|
padding-bottom: 10px;
|
|
}
|
|
|
|
.param-header {
|
|
font-weight: bold;
|
|
}
|
|
|
|
</style>
|
|
</body>
|
|
</html> |