This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger . For this sample, you can use the api key special-key
to test the authorization filters.
- api_key(SecurityScheme)
Name
Type
Description
In
( * ) api_key
ApiKey
Header
- petstore_auth(SecurityScheme)
Name
Type
Description
In
( * )
OAuth2
Query
1. [POST] /pet/{petId}/uploadImage
Name
Type
Description
( * ) petId
integer int64
ID of pet to update
- Request Parameter Form:
Name
Type
Description
additionalMetadata
string
Additional data to pass to server
file
string binary
file to upload
multipart/form-data Request Sample JSON:
{
"additionalMetadata" : " string" ,
"file" : " string"
}
- Response Parameter Form:
Code
Description
200
successful operation
Name
Type
Description
code
integer int32
type
string
message
string
application/json Response Sample JSON:
{
"code" : 1 ,
"type" : " string" ,
"message" : " string"
}
Todo: Update an existing pet
- Request Parameter Form:
Name
Type
Description
id
integer int64
category
object Category
( * ) name
string
( * ) photoUrls
array
tags
array
status
string
pet status in the store
application/json Request Sample JSON:
{
"id" : 1 ,
"category" : {
"id" : 1 ,
"name" : " string"
},
"name" : " Microsoft.OpenApi.Any.OpenApiString" ,
"photoUrls" : [
" string"
],
"tags" : [
{
"id" : 1 ,
"name" : " string"
}
],
"status" : " string"
}
- Response Parameter Form:
Code
Description
400
Invalid ID supplied
- Response Parameter Form:
Code
Description
404
Pet not found
- Response Parameter Form:
Code
Description
405
Validation exception
Todo: Add a new pet to the store
- Request Parameter Form:
Name
Type
Description
id
integer int64
category
object Category
( * ) name
string
( * ) photoUrls
array
tags
array
status
string
pet status in the store
application/json Request Sample JSON:
{
"id" : 1 ,
"category" : {
"id" : 1 ,
"name" : " string"
},
"name" : " Microsoft.OpenApi.Any.OpenApiString" ,
"photoUrls" : [
" string"
],
"tags" : [
{
"id" : 1 ,
"name" : " string"
}
],
"status" : " string"
}
- Response Parameter Form:
Code
Description
405
Invalid input
3. [GET] /pet/findByStatus
Todo: Finds Pets by status
Name
Type
Description
( * ) status
array
Status values that need to be considered for filter
- Response Parameter Form:
Code
Description
200
successful operation
application/json Response Sample JSON:
[
{
"id" : 1 ,
"category" : {
"id" : 1 ,
"name" : " string"
},
"name" : " Microsoft.OpenApi.Any.OpenApiString" ,
"photoUrls" : [
" string"
],
"tags" : [
{
"id" : 1 ,
"name" : " string"
}
],
"status" : " string"
}
]
- Response Parameter Form:
Code
Description
400
Invalid status value
Name
Type
Description
( * ) tags
array
Tags to filter by
- Response Parameter Form:
Code
Description
200
successful operation
application/json Response Sample JSON:
[
{
"id" : 1 ,
"category" : {
"id" : 1 ,
"name" : " string"
},
"name" : " Microsoft.OpenApi.Any.OpenApiString" ,
"photoUrls" : [
" string"
],
"tags" : [
{
"id" : 1 ,
"name" : " string"
}
],
"status" : " string"
}
]
- Response Parameter Form:
Code
Description
400
Invalid tag value
Name
Type
Description
( * ) petId
integer int64
ID of pet to return
- Response Parameter Form:
Code
Description
200
successful operation
Name
Type
Description
id
integer int64
category
object Category
( * ) name
string
( * ) photoUrls
array
tags
array
status
string
pet status in the store
application/json Response Sample JSON:
{
"id" : 1 ,
"category" : {
"id" : 1 ,
"name" : " string"
},
"name" : " Microsoft.OpenApi.Any.OpenApiString" ,
"photoUrls" : [
" string"
],
"tags" : [
{
"id" : 1 ,
"name" : " string"
}
],
"status" : " string"
}
- Response Parameter Form:
Code
Description
400
Invalid ID supplied
- Response Parameter Form:
Code
Description
404
Pet not found
Todo: Updates a pet in the store with form data
Name
Type
Description
( * ) petId
integer int64
ID of pet that needs to be updated
- Request Parameter Form:
Name
Type
Description
name
string
Updated name of the pet
status
string
Updated status of the pet
application/x-www-form-urlencoded Request Sample JSON:
{
"name" : " string" ,
"status" : " string"
}
- Response Parameter Form:
Code
Description
405
Invalid input
Name
Type
Description
api_key
string
| ( * ) petId | integer int64 | Pet id to delete |
- Response Parameter Form:
Code
Description
400
Invalid ID supplied
- Response Parameter Form:
Code
Description
404
Pet not found
6. [GET] /store/inventory
Todo: Returns pet inventories by status
- Response Parameter Form:
Code
Description
200
successful operation
application/json Response Sample JSON:
Todo: Place an order for a pet
- Request Parameter Form:
Name
Type
Description
id
integer int64
petId
integer int64
quantity
integer int32
shipDate
string date-time
status
string
Order Status
complete
boolean
application/json Request Sample JSON:
{
"id" : 1 ,
"petId" : 1 ,
"quantity" : 1 ,
"shipDate" : " string" ,
"status" : " string" ,
"complete" : true
}
- Response Parameter Form:
Code
Description
200
successful operation
Name
Type
Description
id
integer int64
petId
integer int64
quantity
integer int32
shipDate
string date-time
status
string
Order Status
complete
boolean
application/json Response Sample JSON:
{
"id" : 1 ,
"petId" : 1 ,
"quantity" : 1 ,
"shipDate" : " string" ,
"status" : " string" ,
"complete" : true
}
- Response Parameter Form:
Code
Description
400
Invalid Order
8. [GET] /store/order/{orderId}
Todo: Find purchase order by ID
Name
Type
Description
( * ) orderId
integer int64
ID of pet that needs to be fetched
- Response Parameter Form:
Code
Description
200
successful operation
Name
Type
Description
id
integer int64
petId
integer int64
quantity
integer int32
shipDate
string date-time
status
string
Order Status
complete
boolean
application/json Response Sample JSON:
{
"id" : 1 ,
"petId" : 1 ,
"quantity" : 1 ,
"shipDate" : " string" ,
"status" : " string" ,
"complete" : true
}
- Response Parameter Form:
Code
Description
400
Invalid ID supplied
- Response Parameter Form:
Code
Description
404
Order not found
8. [DELETE] /store/order/{orderId}
Todo: Delete purchase order by ID
Name
Type
Description
( * ) orderId
integer int64
ID of the order that needs to be deleted
- Response Parameter Form:
Code
Description
400
Invalid ID supplied
- Response Parameter Form:
Code
Description
404
Order not found
9. [POST] /user/createWithList
Todo: Creates list of users with given input array
- Request Parameter Form:
application/json Request Sample JSON:
[
{
"id" : 1 ,
"username" : " string" ,
"firstName" : " string" ,
"lastName" : " string" ,
"email" : " string" ,
"password" : " string" ,
"phone" : " string" ,
"userStatus" : 1
}
]
- Response Parameter Form:
Code
Description
default
successful operation
10. [GET] /user/{username}
Todo: Get user by user name
Name
Type
Description
( * ) username
string
The name that needs to be fetched. Use user1 for testing.
- Response Parameter Form:
Code
Description
200
successful operation
Name
Type
Description
id
integer int64
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer int32
User Status
application/json Response Sample JSON:
{
"id" : 1 ,
"username" : " string" ,
"firstName" : " string" ,
"lastName" : " string" ,
"email" : " string" ,
"password" : " string" ,
"phone" : " string" ,
"userStatus" : 1
}
- Response Parameter Form:
Code
Description
400
Invalid username supplied
- Response Parameter Form:
Code
Description
404
User not found
10. [PUT] /user/{username}
Name
Type
Description
( * ) username
string
name that need to be updated
- Request Parameter Form:
Name
Type
Description
id
integer int64
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer int32
User Status
application/json Request Sample JSON:
{
"id" : 1 ,
"username" : " string" ,
"firstName" : " string" ,
"lastName" : " string" ,
"email" : " string" ,
"password" : " string" ,
"phone" : " string" ,
"userStatus" : 1
}
- Response Parameter Form:
Code
Description
400
Invalid user supplied
- Response Parameter Form:
Code
Description
404
User not found
10. [DELETE] /user/{username}
Name
Type
Description
( * ) username
string
The name that needs to be deleted
- Response Parameter Form:
Code
Description
400
Invalid username supplied
- Response Parameter Form:
Code
Description
404
User not found
Todo: Logs user into the system
Name
Type
Description
( * ) username
string
The user name for login
| ( * ) password | string | The password for login in clear text |
- Response Parameter Form:
Code
Description
200
successful operation
application/json Response Sample JSON:
- Response Parameter Form:
Code
Description
400
Invalid username/password supplied
Todo: Logs out current logged in user session
- Response Parameter Form:
Code
Description
default
successful operation
13. [POST] /user/createWithArray
Todo: Creates list of users with given input array
- Request Parameter Form:
application/json Request Sample JSON:
[
{
"id" : 1 ,
"username" : " string" ,
"firstName" : " string" ,
"lastName" : " string" ,
"email" : " string" ,
"password" : " string" ,
"phone" : " string" ,
"userStatus" : 1
}
]
- Response Parameter Form:
Code
Description
default
successful operation
- Request Parameter Form:
Name
Type
Description
id
integer int64
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer int32
User Status
application/json Request Sample JSON:
{
"id" : 1 ,
"username" : " string" ,
"firstName" : " string" ,
"lastName" : " string" ,
"email" : " string" ,
"password" : " string" ,
"phone" : " string" ,
"userStatus" : 1
}
- Response Parameter Form:
Code
Description
default
successful operation
Name
Type
Description
code
integer int32
type
string
message
string
Name
Type
Description
id
integer int64
name
string
Name
Type
Description
id
integer int64
category
object Category
( * ) name
string
( * ) photoUrls
array
tags
array
status
string
pet status in the store
Name
Type
Description
id
integer int64
name
string
Name
Type
Description
id
integer int64
petId
integer int64
quantity
integer int32
shipDate
string date-time
status
string
Order Status
complete
boolean
Name
Type
Description
id
integer int64
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer int32
User Status