Swagger Petstore
Version: 1.0.0
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
- APIKey KeyParamName:api_key KeyInQuery:false KeyInHeader:true
- OAuth AuthorizationUrl:http://petstore.swagger.io/oauth/dialogTokenUrl:
[ Jump to Models ]
Table of Contents
(testMethod)
Return type
Example data
Content-Type: application/json
[ "", "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
peticion realizada con exito
Add a new parrow to the store (addParrot)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
405
Invalid input
200
successful operation
inline_response_200_1
Add a new pet to the store (addPet)
Consumes
This API call consumes the following media types via the request header:
application/json
application/xml
Request body
Body Parameter — Pet object that needs to be added to the store
Responses
405
Invalid input
Deletes a pet (deletePet)
Path parameters
petId (required)
Path Parameter — Pet id to delete format: int64
Request headers
Responses
400
Invalid ID supplied
404
Pet not found
Up
post /pet/feed/{petId}
Find pet by ID (feedPet)
schedule pet feeding
Path parameters
petId (required)
Path Parameter — ID of pet to return format: int64
Consumes
This API call consumes the following media types via the request header:
application/json
application/xml
Request body
Body Parameter — Pet object that needs to be added to the store
Request headers
Query parameters
petType (required)
Query Parameter — type of food
status (required)
Query Parameter — status
Responses
200
successful operation
Finds Pets by status (findPetsByStatus)
Multiple status values can be provided with comma separated strings
Query parameters
status (required)
Query Parameter — Status values that need to be considered for filter
Return type
Example data
Content-Type: application/json
[ {
"part" : [ "", "" ],
"name" : "doggie",
"id" : 0,
"status" : "available"
}, {
"part" : [ "", "" ],
"name" : "doggie",
"id" : 0,
"status" : "available"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
400
Invalid status value
Finds Pets by tags (findPetsByTags)
Muliple tags can be provided with comma separated strings. Use\ \ tag1, tag2, tag3 for testing.
Query parameters
tags (required)
Query Parameter — Tags to filter by
Return type
Example data
Content-Type: application/json
[ {
"part" : [ "", "" ],
"name" : "doggie",
"id" : 0,
"status" : "available"
}, {
"part" : [ "", "" ],
"name" : "doggie",
"id" : 0,
"status" : "available"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
400
Invalid tag value
get Parrots (getParrots)
Return type
array[null]
Example data
Content-Type: application/json
[ "", "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
array[null]
Find pet by ID (getPetById)
Returns a single pet
Path parameters
petId (required)
Path Parameter — ID of pet to return format: int64
Return type
Example data
Content-Type: application/json
{
"part" : [ "", "" ],
"name" : "doggie",
"id" : 0,
"status" : "available"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
Pet
400
Invalid ID supplied
404
Pet not found
update parrots (updateParrots)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"parrots" : [ "", "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
405
Invalid input
200
successful operation
inline_response_200
Update an existing pet (updatePet)
Consumes
This API call consumes the following media types via the request header:
application/json
application/xml
Request body
Body Parameter — Pet object that needs to be added to the store
Responses
400
Invalid ID supplied
404
Pet not found
405
Validation exception
Updates a pet in the store with form data (updatePetWithForm)
Path parameters
petId (required)
Path Parameter — ID of pet that needs to be updated format: int64
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (optional)
Form Parameter —
status (optional)
Form Parameter —
Responses
405
Invalid input
Up
post /pet/{petId}/uploadImage
uploads an image (uploadFile)
Path parameters
petId (required)
Path Parameter — ID of pet to update format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"code" : 0,
"type" : "type",
"message" : "message"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
ApiResponse
Up
delete /store/order/{orderId}
Delete purchase order by ID (deleteOrder)
For valid response try integer IDs with positive integer value.\ \ Negative or non-integer values will generate API errors
Path parameters
orderId (required)
Path Parameter — ID of the order that needs to be deleted format: int64
Responses
400
Invalid ID supplied
404
Order not found
Returns pet inventories by status (getInventory)
Returns a map of status codes to quantities
Return type
map[String, Integer]
Example data
Content-Type: application/json
{
"key" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /store/order/{orderId}
Find purchase order by ID (getOrderById)
For valid response try integer IDs with value >= 1 and <= 10.\ \ Other values will generated exceptions
Path parameters
orderId (required)
Path Parameter — ID of pet that needs to be fetched format: int64
Return type
Example data
Content-Type: application/json
{
"petId" : 6,
"quantity" : 1,
"id" : 0,
"shipDate" : "2000-01-23T04:56:07.000+00:00",
"complete" : false,
"status" : "placed"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
Order
400
Invalid ID supplied
404
Order not found
Place an order for a pet (placeOrder)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — order placed for purchasing the pet
Return type
Example data
Content-Type: application/json
{
"petId" : 6,
"quantity" : 1,
"id" : 0,
"shipDate" : "2000-01-23T04:56:07.000+00:00",
"complete" : false,
"status" : "placed"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
Order
400
Invalid Order
Create user (createUser)
This can only be done by the logged in user.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Created user object
Responses
default
successful operation
Up
post /user/createWithArray
Creates list of users with given input array (createUsersWithArrayInput)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of user object
Responses
default
successful operation
Up
post /user/createWithList
Creates list of users with given input array (createUsersWithListInput)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of user object
Responses
default
successful operation
Up
delete /user/{username}
Delete user (deleteUser)
This can only be done by the logged in user.
Path parameters
username (required)
Path Parameter — The name that needs to be deleted
Responses
400
Invalid username supplied
404
User not found
Get user by user name (getUserByName)
Path parameters
username (required)
Path Parameter — The name that needs to be fetched. Use user1 for testing.
Return type
Example data
Content-Type: application/json
{
"firstName" : "firstName",
"lastName" : "lastName",
"password" : "password",
"userStatus" : 6,
"phone" : "phone",
"id" : 0,
"email" : "email",
"username" : "username"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
User
400
Invalid username supplied
404
User not found
Logs user into the system (loginUser)
Query parameters
username (required)
Query Parameter — The user name for login
password (required)
Query Parameter — The password for login in clear text
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
successful operation
String
400
Invalid username/password supplied
Logs out current logged in user session (logoutUser)
Responses
default
successful operation
Updated user (userUsernamePut)
This can only be done by the logged in user.
Path parameters
username (required)
Path Parameter — name that need to be updated
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Updated user object
Responses
400
Invalid user supplied
404
User not found
[ Jump to Methods ]
Table of Contents
AllPetsResponse
ApiResponse
Cat
Category
Dog
Macaw
Order
Parakeet
PartFour
PartMaster
PartOne
PartThree
PartTwo
Pet
Pup
Tag
Test
User
body
body_1
body_2
inline_response_200
inline_response_200_1
val_MemberChoice1
val_MemberChoice2
val_Members
code (optional)
type (optional)
message (optional)
id (optional)
name
example: doggie
status (optional)
String pet status in the store
available
pending
sold
part (optional)
hunts (optional)
age (optional)
id (optional)
name (optional)
subcategories (optional)
id (optional)
name
example: doggie
status (optional)
String pet status in the store
available
pending
sold
part (optional)
bark (optional)
breed (optional)
Dingo
Husky
Retriever
Shepherd
color (optional)
singer (optional)
id (optional)
petId (optional)
quantity (optional)
shipDate (optional)
status (optional)
placed
approved
delivered
complete (optional)
color (optional)
soundRepeater (optional)
destination (optional)
origin (optional)
id (optional)
name
example: doggie
status (optional)
String pet status in the store
available
pending
sold
part (optional)
id (optional)
name (optional)
id (optional)
username (optional)
firstName (optional)
lastName (optional)
email (optional)
password (optional)
phone (optional)
userStatus (optional)
name (optional)
String Updated name of the pet
status (optional)
String Updated status of the pet
Business Term: Scheme Member
Definition: Information about a Member of the Scheme.
Purpose: To have enough information to be able to produce a Statement of Account indicating premium due.
val_date_of_birth
date Business Term: Date Of Birth
Definition: The date of birth of the member.
Purpose: To be able to uniquely identify a member within a scheme. format: date
val_leaving_date (optional)
date Business Term: Leaving Date
Definition: The date the member left/is due to leave the scheme.
Purpose: To identify those members that have left or are due to leave the scheme. To be able to calculate the benefit insured/premium payable in respect of the member/category. format: date
Business Term: Scheme Member
Definition: Information about a Member of the Scheme.
Purpose: To have enough information to be able to produce a Statement of Account indicating premium due.
val_leaving_date (optional)
date Business Term: Leaving Date
Definition: The date the member left/is due to leave the scheme.
Purpose: To identify those members that have left or are due to leave the scheme. To be able to calculate the benefit insured/premium payable in respect of the member/category. format: date
Business Term: Scheme Members
Definition: Information about the Members of the Scheme.
Purpose: To have enough information to be able to produce a Statement of Account indicating premium due.
val_member
array[null] Business Term: Scheme Member
Definition: Information about a Member of the Scheme.
Purpose: To have enough information to be able to produce a Statement of Account indicating premium due.