mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-08 11:23:58 +00:00
1416 lines
52 KiB
HTML
1416 lines
52 KiB
HTML
<?xml version="1.0"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>Swagger Petstore</title>
|
|
<style type="text/css">
|
|
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;
|
|
margin-bottom: 2px;
|
|
}
|
|
|
|
.http-method {
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
.up {
|
|
float:right;
|
|
}
|
|
|
|
.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;
|
|
}
|
|
|
|
.param-enum-header {
|
|
width: 700px;
|
|
padding: 0 0 0 60px;
|
|
color: #777;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-enum {
|
|
width: 700px;
|
|
padding: 0 0 0 80px;
|
|
color: #777;
|
|
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;
|
|
}
|
|
|
|
.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>
|
|
</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">Contact Info: <a href="apiteam@swagger.io">apiteam@swagger.io</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>
|
|
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h2>Table of Contents </h2>
|
|
<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=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=inline_arbitrary_object</code></a></li>
|
|
<li><a href="#petPetIdtestingByteArraytrueGet"><code><span class="http-method">get</span> /pet/{petId}?testing_byte_array=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=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>
|
|
<li><a href="#createUsersWithArrayInput"><code><span class="http-method">post</span> /user/createWithArray</code></a></li>
|
|
<li><a href="#createUsersWithListInput"><code><span class="http-method">post</span> /user/createWithList</code></a></li>
|
|
<li><a href="#deleteUser"><code><span class="http-method">delete</span> /user/{username}</code></a></li>
|
|
<li><a href="#getUserByName"><code><span class="http-method">get</span> /user/{username}</code></a></li>
|
|
<li><a href="#loginUser"><code><span class="http-method">get</span> /user/login</code></a></li>
|
|
<li><a href="#logoutUser"><code><span class="http-method">get</span> /user/logout</code></a></li>
|
|
<li><a href="#updateUser"><code><span class="http-method">put</span> /user/{username}</code></a></li>
|
|
</ol>
|
|
|
|
<div class="method"><a name="addPet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /pet</code></pre></div>
|
|
<div class="method-summary">Add a new pet to the store (<span class="nickname">addPet</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> — Pet object that needs to be added to the store </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>
|
|
<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=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> — 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>
|
|
<h4 class="field-label">405</h4>
|
|
Invalid input
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deletePet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /pet/{petId}</code></pre></div>
|
|
<div class="method-summary">Deletes a pet (<span class="nickname">deletePet</span>)</div>
|
|
<div class="method-notes"></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> — Pet id to delete </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>
|
|
<h4 class="field-label">400</h4>
|
|
Invalid pet value
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="findPetsByStatus"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /pet/findByStatus</code></pre></div>
|
|
<div class="method-summary">Finds Pets by status (<span class="nickname">findPetsByStatus</span>)</div>
|
|
<div class="method-notes">Multiple status values can be provided with comma separated strings</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> — Status values that need to be considered for query default: available</div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Pet">Pet</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="findPetsByTags"/>
|
|
<div class="method-path">
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query 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">
|
|
array[<a href="#Pet">Pet</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 tag value
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getPetById"/>
|
|
<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}</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 < 10. ID > 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> — 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">Pet</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="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=inline_arbitrary_object</code></pre></div>
|
|
<div class="method-summary">Fake endpoint to test inline arbitrary object return by 'Find pet by ID' (<span class="nickname">getPetByIdInObject</span>)</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">Path 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="#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=true</code></pre></div>
|
|
<div class="method-summary">Fake endpoint to test byte array return by 'Find pet by ID' (<span class="nickname">petPetIdtestingByteArraytrueGet</span>)</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">Path 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">
|
|
|
|
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>
|
|
<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="updatePet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /pet</code></pre></div>
|
|
<div class="method-summary">Update an existing pet (<span class="nickname">updatePet</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> — Pet object that needs to be added to the store </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>
|
|
<h4 class="field-label">400</h4>
|
|
Invalid ID supplied
|
|
<h4 class="field-label">404</h4>
|
|
Pet not found
|
|
<h4 class="field-label">405</h4>
|
|
Validation exception
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updatePetWithForm"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /pet/{petId}</code></pre></div>
|
|
<div class="method-summary">Updates a pet in the store with form data (<span class="nickname">updatePetWithForm</span>)</div>
|
|
<div class="method-notes"></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> — ID of pet that needs to be updated </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<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/x-www-form-urlencoded</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Form parameters</h3>
|
|
<div class="field-items">
|
|
<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 -->
|
|
|
|
|
|
<!--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">405</h4>
|
|
Invalid input
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="uploadFile"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /pet/{petId}/uploadImage</code></pre></div>
|
|
<div class="method-summary">uploads an image (<span class="nickname">uploadFile</span>)</div>
|
|
<div class="method-notes"></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> — ID of pet to update </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<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>multipart/form-data</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Form parameters</h3>
|
|
<div class="field-items">
|
|
<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 -->
|
|
|
|
|
|
<!--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">0</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteOrder"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /store/order/{orderId}</code></pre></div>
|
|
<div class="method-summary">Delete purchase order by ID (<span class="nickname">deleteOrder</span>)</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">Path 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 -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--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">400</h4>
|
|
Invalid ID supplied
|
|
<h4 class="field-label">404</h4>
|
|
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> — 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>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /store/inventory</code></pre></div>
|
|
<div class="method-summary">Returns pet inventories by status (<span class="nickname">getInventory</span>)</div>
|
|
<div class="method-notes">Returns a map of status codes to quantities</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
map[String, Integer]
|
|
</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
|
|
</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=arbitrary_object</code></pre></div>
|
|
<div class="method-summary">Fake endpoint to test arbitrary object return by 'Get inventory' (<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>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getOrderById"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /store/order/{orderId}</code></pre></div>
|
|
<div class="method-summary">Find purchase order by ID (<span class="nickname">getOrderById</span>)</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">Path 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">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 ID supplied
|
|
<h4 class="field-label">404</h4>
|
|
Order not found
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="placeOrder"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /store/order</code></pre></div>
|
|
<div class="method-summary">Place an order for a pet (<span class="nickname">placeOrder</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
<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> — order placed for purchasing the pet </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<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 Order
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createUser"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /user</code></pre></div>
|
|
<div class="method-summary">Create user (<span class="nickname">createUser</span>)</div>
|
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
|
|
|
|
|
|
|
<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> — Created user object </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>
|
|
<h4 class="field-label">0</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createUsersWithArrayInput"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /user/createWithArray</code></pre></div>
|
|
<div class="method-summary">Creates list of users with given input array (<span class="nickname">createUsersWithArrayInput</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
<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> — List of user object </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>
|
|
<h4 class="field-label">0</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createUsersWithListInput"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /user/createWithList</code></pre></div>
|
|
<div class="method-summary">Creates list of users with given input array (<span class="nickname">createUsersWithListInput</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
<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> — List of user object </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>
|
|
<h4 class="field-label">0</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteUser"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /user/{username}</code></pre></div>
|
|
<div class="method-summary">Delete user (<span class="nickname">deleteUser</span>)</div>
|
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
|
|
|
<h3 class="field-label">Path 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 -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--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">400</h4>
|
|
Invalid username supplied
|
|
<h4 class="field-label">404</h4>
|
|
User not found
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getUserByName"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /user/{username}</code></pre></div>
|
|
<div class="method-summary">Get user by user name (<span class="nickname">getUserByName</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path 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">User</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
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{id=1, username=johnp, firstName=John, lastName=Public, email=johnp@swagger.io, password=-secret-, phone=0123456789, userStatus=0}</code></pre>
|
|
<h4 class="field-label">400</h4>
|
|
Invalid username supplied
|
|
<h4 class="field-label">404</h4>
|
|
User not found
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="loginUser"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /user/login</code></pre></div>
|
|
<div class="method-summary">Logs user into the system (<span class="nickname">loginUser</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query 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">
|
|
|
|
String
|
|
</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 username/password supplied
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="logoutUser"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /user/logout</code></pre></div>
|
|
<div class="method-summary">Logs out current logged in user session (<span class="nickname">logoutUser</span>)</div>
|
|
<div class="method-notes"></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">0</h4>
|
|
successful operation
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateUser"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /user/{username}</code></pre></div>
|
|
<div class="method-summary">Updated user (<span class="nickname">updateUser</span>)</div>
|
|
<div class="method-notes">This can only be done by the logged in user.</div>
|
|
|
|
<h3 class="field-label">Path 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> <!-- field-items -->
|
|
|
|
|
|
<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> — Updated user object </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>
|
|
<h4 class="field-label">400</h4>
|
|
Invalid user supplied
|
|
<h4 class="field-label">404</h4>
|
|
User not found
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="up"><a href="#__Models">Up</a></div>
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<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="#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>
|
|
<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> <!-- 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> <!-- 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-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> <!-- 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">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-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> <!-- 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> <!-- field-items -->
|
|
</div>
|
|
</body>
|
|
</html>
|