2016-09-12 03:00:02 +00:00
<!doctype html>
< html >
2015-06-09 07:25:09 +00:00
< head >
2015-10-30 08:37:23 +00:00
< title > Swagger Petstore< / title >
< style type = "text/css" >
2016-10-12 09:14:36 +00:00
body {
2015-10-30 08:37:23 +00:00
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;
}
.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;
}
2016-10-12 09:14:36 +00:00
2015-10-30 08:37:23 +00:00
< / style >
2015-06-09 07:25:09 +00:00
< / head >
< body >
< h1 > Swagger Petstore< / h1 >
2017-03-23 07:15:01 +00:00
< 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 < a href = "http://swagger.io/irc/" > irc.freenode.net, #swagger< / a > . For this sample, you can use the api key < code > special-key< / code > to test the authorization filters.< / div >
< div class = "app-desc" > More information: < a href = "" > < / a > < / div >
2015-06-08 03:50:35 +00:00
< 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 >
2016-09-12 03:00:02 +00:00
< div class = "app-desc" > BasePath:/v2< / div >
2015-06-09 07:25:09 +00:00
< 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 >
2016-09-12 03:00:02 +00:00
< ol >
< li > APIKey KeyParamName:api_key KeyInQuery:false KeyInHeader:true< / li >
< li > OAuth AuthorizationUrl:http://petstore.swagger.io/api/oauth/dialogTokenUrl:< / li >
< / ol >
2015-10-30 08:37:23 +00:00
< h2 > < a name = "__Methods" > Methods< / a > < / h2 >
[ Jump to < a href = "#__Models" > Models< / a > ]
2016-10-12 09:14:36 +00:00
< h3 > Table of Contents < / h3 >
2015-10-30 08:37:23 +00:00
< div class = "method-summary" > < / div >
2016-10-12 09:14:36 +00:00
< h4 > < a href = "#Pet" > Pet< / a > < / h4 >
< ul >
2015-10-30 08:37:23 +00:00
< li > < a href = "#addPet" > < code > < span class = "http-method" > post< / span > /pet< / code > < / a > < / li >
2016-04-11 12:43:06 +00:00
< li > < a href = "#deletePet" > < code > < span class = "http-method" > delete< / span > /pet/{petId}< / code > < / a > < / li >
2015-10-30 08:37:23 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< li > < a href = "#updatePet" > < code > < span class = "http-method" > put< / span > /pet< / code > < / a > < / li >
2015-10-30 08:37:23 +00:00
< 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 >
2016-10-12 09:14:36 +00:00
< / ul >
< h4 > < a href = "#Store" > Store< / a > < / h4 >
< ul >
2016-04-11 12:43:06 +00:00
< li > < a href = "#deleteOrder" > < code > < span class = "http-method" > delete< / span > /store/order/{orderId}< / code > < / a > < / li >
2015-10-30 08:37:23 +00:00
< li > < a href = "#getInventory" > < code > < span class = "http-method" > get< / span > /store/inventory< / code > < / a > < / li >
< li > < a href = "#getOrderById" > < code > < span class = "http-method" > get< / span > /store/order/{orderId}< / code > < / a > < / li >
2016-04-11 12:43:06 +00:00
< li > < a href = "#placeOrder" > < code > < span class = "http-method" > post< / span > /store/order< / code > < / a > < / li >
2016-10-12 09:14:36 +00:00
< / ul >
< h4 > < a href = "#User" > User< / a > < / h4 >
< ul >
2015-10-30 08:37:23 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
< 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 >
2016-10-12 09:14:36 +00:00
< / ul >
2015-10-30 08:37:23 +00:00
2016-10-12 09:14:36 +00:00
< h1 > < a name = "Pet" > Pet< / a > < / h1 >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "addPet" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
< div class = "method-notes" > < / div >
2015-10-30 08:37:23 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#Pet" > Pet< / a > (required)< / div >
2015-06-09 07:25:09 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — Pet object that needs to be added to the store < / div >
2016-12-13 07:52:22 +00:00
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
< li > < code > application/json< / code > < / li >
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 405< / h4 >
Invalid input
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-04-11 12:43:06 +00:00
< 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 >
2016-09-12 03:00:02 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — Pet id to delete format: int64< / div >
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
2016-10-13 10:15:04 +00:00
< h3 class = "field-label" > Request headers< / h3 >
< div class = "field-items" >
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
<!-- 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2016-04-11 12:43:06 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 400< / h4 >
Invalid pet value
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< / div > <!-- method -->
< hr / >
2015-10-30 08:37:23 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< div class = "method-notes" > Multiple status values can be provided with comma separated strings< / div >
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Query parameters< / h3 >
< div class = "field-items" >
2016-04-16 09:51:12 +00:00
< div class = "param" > status (required)< / div >
2015-10-30 08:37:23 +00:00
2016-04-16 09:51:12 +00:00
< div class = "param-desc" > < span class = "param-type" > Query Parameter< / span > — Status values that need to be considered for filter < / div >
2015-10-30 08:37:23 +00:00
< / div > <!-- field - items -->
< h3 class = "field-label" > Return type< / h3 >
2016-04-11 12:43:06 +00:00
< div class = "return-type" >
array[< a href = "#Pet" > Pet< / a > ]
< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < Pet >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
2016-09-12 03:00:02 +00:00
< name > doggie< / name >
< photoUrls >
2017-03-10 13:47:20 +00:00
< photoUrls > aeiou< / photoUrls >
2016-09-12 03:00:02 +00:00
< / photoUrls >
< tags >
< / tags >
2017-03-10 13:47:20 +00:00
< status > aeiou< / status >
2016-09-12 03:00:02 +00:00
< / Pet > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > [ {
2017-03-23 07:15:01 +00:00
"photoUrls" : [ "aeiou" ],
"name" : "doggie",
"id" : 0,
2017-03-10 13:47:20 +00:00
"category" : {
2017-03-23 07:15:01 +00:00
"name" : "aeiou",
"id" : 6
2017-03-10 13:47:20 +00:00
},
2017-03-23 07:15:01 +00:00
"tags" : [ {
"name" : "aeiou",
"id" : 1
} ],
"status" : "available"
2016-09-12 03:00:02 +00:00
} ]< / code > < / pre >
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 400< / h4 >
Invalid status value
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / 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 >
2016-04-16 09:51:12 +00:00
< div class = "method-notes" > Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.< / div >
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Query parameters< / h3 >
< div class = "field-items" >
2016-04-16 09:51:12 +00:00
< div class = "param" > tags (required)< / div >
2015-10-30 08:37:23 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< div class = "return-type" >
array[< a href = "#Pet" > Pet< / a > ]
< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < Pet >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
2016-09-12 03:00:02 +00:00
< name > doggie< / name >
< photoUrls >
2017-03-10 13:47:20 +00:00
< photoUrls > aeiou< / photoUrls >
2016-09-12 03:00:02 +00:00
< / photoUrls >
< tags >
< / tags >
2017-03-10 13:47:20 +00:00
< status > aeiou< / status >
2016-09-12 03:00:02 +00:00
< / Pet > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > [ {
2017-03-23 07:15:01 +00:00
"photoUrls" : [ "aeiou" ],
"name" : "doggie",
"id" : 0,
2017-03-10 13:47:20 +00:00
"category" : {
2017-03-23 07:15:01 +00:00
"name" : "aeiou",
"id" : 6
2017-03-10 13:47:20 +00:00
},
2017-03-23 07:15:01 +00:00
"tags" : [ {
"name" : "aeiou",
"id" : 1
} ],
"status" : "available"
2016-09-12 03:00:02 +00:00
} ]< / code > < / pre >
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 400< / h4 >
Invalid tag value
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / 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 >
2016-04-16 09:51:12 +00:00
< div class = "method-notes" > Returns a single pet< / div >
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
< div class = "field-items" >
< div class = "param" > petId (required)< / div >
2016-09-12 03:00:02 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — ID of pet to return format: int64< / div >
2015-10-30 08:37:23 +00:00
< / div > <!-- field - items -->
< h3 class = "field-label" > Return type< / h3 >
2016-04-11 12:43:06 +00:00
< div class = "return-type" >
< a href = "#Pet" > Pet< / a >
< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < Pet >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
2016-09-12 03:00:02 +00:00
< name > doggie< / name >
< photoUrls >
2017-03-10 13:47:20 +00:00
< photoUrls > aeiou< / photoUrls >
2016-09-12 03:00:02 +00:00
< / photoUrls >
< tags >
< / tags >
2017-03-10 13:47:20 +00:00
< status > aeiou< / status >
2016-09-12 03:00:02 +00:00
< / Pet > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"photoUrls" : [ "aeiou" ],
"name" : "doggie",
"id" : 0,
2017-03-10 13:47:20 +00:00
"category" : {
2017-03-23 07:15:01 +00:00
"name" : "aeiou",
"id" : 6
2017-03-10 13:47:20 +00:00
},
2017-03-23 07:15:01 +00:00
"tags" : [ {
"name" : "aeiou",
"id" : 1
} ],
"status" : "available"
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
< li > < code > application/json< / code > < / li >
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#Pet" > Pet< / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 400< / h4 >
2016-04-11 12:43:06 +00:00
Invalid ID supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 404< / h4 >
Pet not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "updatePet" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< li > < code > application/json< / code > < / li >
< li > < code > application/xml< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Request body< / h3 >
2015-10-30 08:37:23 +00:00
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#Pet" > Pet< / a > (required)< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — Pet object that needs to be added to the store < / div >
2016-12-13 07:52:22 +00:00
2015-10-30 08:37:23 +00:00
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 400< / h4 >
Invalid ID supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 404< / h4 >
Pet not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 405< / h4 >
Validation exception
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "updatePetWithForm" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
< div class = "field-items" >
< div class = "param" > petId (required)< / div >
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — ID of pet that needs to be updated format: int64< / div >
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Form parameters< / h3 >
< div class = "field-items" >
< div class = "param" > name (optional)< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Form Parameter< / span > — Updated name of the pet < / div > < div class = "param" > status (optional)< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< 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 -->
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 405< / h4 >
Invalid input
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "uploadFile" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
< div class = "method-notes" > < / div >
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
2015-10-30 08:37:23 +00:00
< div class = "field-items" >
2016-04-11 12:43:06 +00:00
< div class = "param" > petId (required)< / div >
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — ID of pet to update format: int64< / div >
2015-10-30 08:37:23 +00:00
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Form parameters< / h3 >
< div class = "field-items" >
< div class = "param" > additionalMetadata (optional)< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< 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 -->
2016-04-16 09:51:12 +00:00
< h3 class = "field-label" > Return type< / h3 >
< div class = "return-type" >
< a href = "#ApiResponse" > ApiResponse< / a >
< / div >
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"code" : 0,
"type" : "aeiou",
"message" : "aeiou"
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-10-30 08:37:23 +00:00
< 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 >
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2016-04-16 09:51:12 +00:00
< h4 class = "field-label" > 200< / h4 >
2015-10-30 08:37:23 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#ApiResponse" > ApiResponse< / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-10-12 09:14:36 +00:00
< h1 > < a name = "Store" > Store< / a > < / h1 >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "deleteOrder" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
< div class = "field-items" >
< div class = "param" > orderId (required)< / div >
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — ID of the order that needs to be deleted < / div >
2015-10-30 08:37:23 +00:00
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 400< / h4 >
Invalid ID supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 404< / h4 >
Order not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< / div > <!-- method -->
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "getInventory" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Return type< / h3 >
< div class = "return-type" >
map[String, Integer]
< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"key" : 0
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-10-30 08:37:23 +00:00
< 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 >
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 200< / h4 >
2015-10-30 08:37:23 +00:00
successful operation
2016-09-12 03:00:02 +00:00
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "getOrderById" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2017-03-23 07:15:01 +00:00
< div class = "method-notes" > For valid response try integer IDs with value < = 5 or > 10. Other values will generated exceptions< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-04-11 12:43:06 +00:00
< div class = "param" > orderId (required)< / div >
2015-06-09 07:25:09 +00:00
2016-09-12 03:00:02 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — ID of pet that needs to be fetched format: int64< / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< 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 -->
2015-06-09 07:25:09 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < Order >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
< petId > 123456789< / petId >
< quantity > 123< / quantity >
2016-09-12 03:00:02 +00:00
< shipDate > 2000-01-23T04:56:07.000Z< / shipDate >
2017-03-10 13:47:20 +00:00
< status > aeiou< / status >
2016-09-12 03:00:02 +00:00
< complete > true< / complete >
< / Order > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"petId" : 6,
"quantity" : 1,
"id" : 0,
"shipDate" : "2000-01-23T04:56:07.000+00:00",
2017-03-10 13:47:20 +00:00
"complete" : false,
2017-03-23 07:15:01 +00:00
"status" : "placed"
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 200< / h4 >
2015-10-30 08:37:23 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#Order" > Order< / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 400< / h4 >
Invalid ID supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 404< / h4 >
Order not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "placeOrder" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
< div class = "method-notes" > < / div >
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Request body< / h3 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#Order" > Order< / a > (required)< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — order placed for purchasing the pet < / div >
2016-12-13 07:52:22 +00:00
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
2015-06-09 07:25:09 +00:00
< h3 class = "field-label" > Return type< / h3 >
2016-04-11 12:43:06 +00:00
< div class = "return-type" >
< a href = "#Order" > Order< / a >
< / div >
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-10-30 08:37:23 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < Order >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
< petId > 123456789< / petId >
< quantity > 123< / quantity >
2016-09-12 03:00:02 +00:00
< shipDate > 2000-01-23T04:56:07.000Z< / shipDate >
2017-03-10 13:47:20 +00:00
< status > aeiou< / status >
2016-09-12 03:00:02 +00:00
< complete > true< / complete >
< / Order > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"petId" : 6,
"quantity" : 1,
"id" : 0,
"shipDate" : "2000-01-23T04:56:07.000+00:00",
2017-03-10 13:47:20 +00:00
"complete" : false,
2017-03-23 07:15:01 +00:00
"status" : "placed"
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#Order" > Order< / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 400< / h4 >
2016-04-11 12:43:06 +00:00
Invalid Order
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-10-12 09:14:36 +00:00
< h1 > < a name = "User" > User< / a > < / h1 >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "createUser" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Request body< / h3 >
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#User" > User< / a > (required)< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — Created user object < / div >
2016-12-13 07:52:22 +00:00
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2017-03-10 13:47:20 +00:00
< h4 class = "field-label" > default< / h4 >
2015-10-30 08:37:23 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "createUsersWithArrayInput" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
< div class = "method-notes" > < / div >
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Request body< / h3 >
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#User" > User< / a > (required)< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — List of user object < / div >
2016-12-13 07:52:22 +00:00
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2016-04-11 12:43:06 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2017-03-10 13:47:20 +00:00
< h4 class = "field-label" > default< / h4 >
2016-04-11 12:43:06 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< / 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" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#User" > User< / a > (required)< / div >
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — List of user object < / div >
2016-12-13 07:52:22 +00:00
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2017-03-10 13:47:20 +00:00
< h4 class = "field-label" > default< / h4 >
2015-10-30 08:37:23 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "deleteUser" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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 >
2015-06-09 07:25:09 +00:00
< div class = "method-notes" > This can only be done by the logged in user.< / div >
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2015-10-30 08:37:23 +00:00
< div class = "param" > username (required)< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — The name that needs to be deleted < / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
<!-- 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2016-04-11 12:43:06 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 400< / h4 >
Invalid username supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 404< / h4 >
User not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< / 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 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-04-11 12:43:06 +00:00
< div class = "param" > username (required)< / div >
2015-06-09 07:25:09 +00:00
2017-03-23 07:15:01 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — The name that needs to be fetched. Use user1 for testing. < / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2016-04-11 12:43:06 +00:00
< 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 -->
2015-06-09 07:25:09 +00:00
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
< pre class = "example" > < code > < User >
2017-03-10 13:47:20 +00:00
< id > 123456789< / id >
< username > aeiou< / username >
< firstName > aeiou< / firstName >
< lastName > aeiou< / lastName >
< email > aeiou< / email >
< password > aeiou< / password >
< phone > aeiou< / phone >
< userStatus > 123< / userStatus >
2016-09-12 03:00:02 +00:00
< / User > < / code > < / pre >
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/json< / div >
< pre class = "example" > < code > {
2017-03-23 07:15:01 +00:00
"firstName" : "aeiou",
2016-09-12 03:00:02 +00:00
"lastName" : "aeiou",
2017-03-23 07:15:01 +00:00
"password" : "aeiou",
"userStatus" : 6,
2016-09-12 03:00:02 +00:00
"phone" : "aeiou",
2017-03-23 07:15:01 +00:00
"id" : 0,
2016-09-12 03:00:02 +00:00
"email" : "aeiou",
2017-03-23 07:15:01 +00:00
"username" : "aeiou"
2016-09-12 03:00:02 +00:00
}< / code > < / pre >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Responses< / h3 >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#User" > User< / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 400< / h4 >
2016-04-11 12:43:06 +00:00
Invalid username supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 404< / h4 >
User not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
2016-04-11 12:43:06 +00:00
< div class = "method" > < a name = "loginUser" / >
2015-10-30 08:37:23 +00:00
< div class = "method-path" >
< a class = "up" href = "#__Methods" > Up< / a >
2016-04-11 12:43:06 +00:00
< 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" >
2016-04-16 09:51:12 +00:00
< div class = "param" > username (required)< / div >
2016-04-11 12:43:06 +00:00
2016-04-16 09:51:12 +00:00
< div class = "param-desc" > < span class = "param-type" > Query Parameter< / span > — The user name for login < / div > < div class = "param" > password (required)< / div >
2016-04-11 12:43:06 +00:00
< 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 -->
2016-09-12 03:00:02 +00:00
< h3 class = "field-label" > Example data< / h3 >
< div class = "example-data-content-type" > Content-Type: application/xml< / div >
2017-03-10 13:47:20 +00:00
< pre class = "example" > < code > aeiou< / code > < / pre >
2016-09-12 03:00:02 +00:00
< 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 >
2016-04-11 12:43:06 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2016-04-11 12:43:06 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 200< / h4 >
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#String" > String< / a >
2016-04-11 12:43:06 +00:00
< h4 class = "field-label" > 400< / h4 >
Invalid username/password supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< / 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2016-04-11 12:43:06 +00:00
< / ul >
< h3 class = "field-label" > Responses< / h3 >
2017-03-10 13:47:20 +00:00
< h4 class = "field-label" > default< / h4 >
2016-04-11 12:43:06 +00:00
successful operation
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2016-04-11 12:43:06 +00:00
< / 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 >
2015-10-30 08:37:23 +00:00
< div class = "method-notes" > This can only be done by the logged in user.< / div >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Path parameters< / h3 >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
< div class = "param" > username (required)< / div >
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Path Parameter< / span > — name that need to be deleted < / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
2015-10-30 08:37:23 +00:00
2016-04-11 12:43:06 +00:00
< h3 class = "field-label" > Request body< / h3 >
< div class = "field-items" >
2016-12-13 07:52:22 +00:00
< div class = "param" > body < a href = "#User" > User< / a > (required)< / div >
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
< div class = "param-desc" > < span class = "param-type" > Body Parameter< / span > — Updated user object < / div >
2016-12-13 07:52:22 +00:00
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
2015-06-09 07:25:09 +00:00
2016-04-11 12:43:06 +00:00
<!-- Todo: process Response Object and its headers, schema, examples -->
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< 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/xml< / code > < / li >
2016-04-16 09:51:12 +00:00
< li > < code > application/json< / code > < / li >
2015-10-30 08:37:23 +00:00
< / ul >
2015-06-09 07:25:09 +00:00
2015-10-30 08:37:23 +00:00
< h3 class = "field-label" > Responses< / h3 >
< h4 class = "field-label" > 400< / h4 >
2016-04-11 12:43:06 +00:00
Invalid user supplied
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-10-30 08:37:23 +00:00
< h4 class = "field-label" > 404< / h4 >
User not found
2016-09-12 03:00:02 +00:00
< a href = "#" > < / a >
2015-06-09 07:25:09 +00:00
< / div > <!-- method -->
2015-10-30 08:37:23 +00:00
< hr / >
< h2 > < a name = "__Models" > Models< / a > < / h2 >
[ Jump to < a href = "#__Methods" > Methods< / a > ]
2016-10-12 09:14:36 +00:00
< h3 > Table of Contents< / h3 >
2015-10-30 08:37:23 +00:00
< ol >
2017-03-10 13:47:20 +00:00
< li > < a href = "#ApiResponse" > < code > ApiResponse< / code > - An uploaded response< / a > < / li >
< li > < a href = "#Category" > < code > Category< / code > - Pet catehgry< / a > < / li >
< li > < a href = "#Order" > < code > Order< / code > - Pet Order< / a > < / li >
< li > < a href = "#Pet" > < code > Pet< / code > - a Pet< / a > < / li >
< li > < a href = "#Tag" > < code > Tag< / code > - Pet Tag< / a > < / li >
< li > < a href = "#User" > < code > User< / code > - a User< / a > < / li >
2015-10-30 08:37:23 +00:00
< / ol >
2015-06-09 07:25:09 +00:00
< div class = "model" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "ApiResponse" > < code > ApiResponse< / code > - An uploaded response< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > Describes the result of uploading an image resource< / div >
2016-04-11 12:43:06 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > code (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#integer" > Integer< / a > < / span > format: int32< / div >
< div class = "param" > type (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > message (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
< / div >
< div class = "model" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "Category" > < code > Category< / code > - Pet catehgry< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > A category for a pet< / div >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > id (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > name (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
< / div >
< div class = "model" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "Order" > < code > Order< / code > - Pet Order< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > An order for a pets from the pet store< / div >
2015-06-09 07:25:09 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > id (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > petId (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > quantity (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#integer" > Integer< / a > < / span > format: int32< / div >
< div class = "param" > shipDate (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#DateTime" > Date< / a > < / span > format: date-time< / div >
< div class = "param" > status (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > Order Status < / div >
2015-10-30 08:37:23 +00:00
< 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 >
2016-09-12 03:00:02 +00:00
< div class = "param" > complete (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#boolean" > Boolean< / a > < / span > < / div >
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
< / div >
< div class = "model" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "Pet" > < code > Pet< / code > - a Pet< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > A pet for sale in the pet store< / div >
2016-04-11 12:43:06 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > id (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > category (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#Category" > Category< / a > < / span > < / div >
< div class = "param" > name < / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > photoUrls < / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > array[String]< / a > < / span > < / div >
< div class = "param" > tags (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#Tag" > array[Tag]< / a > < / span > < / div >
< div class = "param" > status (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > pet status in the store < / div >
2016-04-11 12:43:06 +00:00
< 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" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "Tag" > < code > Tag< / code > - Pet Tag< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > A tag for a pet< / div >
2016-04-11 12:43:06 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > id (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > name (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
2016-04-11 12:43:06 +00:00
< / div > <!-- field - items -->
< / div >
< div class = "model" >
2017-03-10 13:47:20 +00:00
< h3 > < a name = "User" > < code > User< / code > - a User< / a > < a class = "up" href = "#__Models" > Up< / a > < / h3 >
2016-09-24 03:14:36 +00:00
< div class = 'model-description' > A User who is purchasing from the pet store< / div >
2016-04-11 12:43:06 +00:00
< div class = "field-items" >
2016-09-12 03:00:02 +00:00
< div class = "param" > id (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#long" > Long< / a > < / span > format: int64< / div >
< div class = "param" > username (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > firstName (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > lastName (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > email (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > password (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > phone (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#string" > String< / a > < / span > < / div >
< div class = "param" > userStatus (optional)< / div > < div class = "param-desc" > < span class = "param-type" > < a href = "#integer" > Integer< / a > < / span > User Status format: int32< / div >
2015-06-09 07:25:09 +00:00
< / div > <!-- field - items -->
< / div >
< / body >
2015-10-30 08:37:23 +00:00
< / html >
