FORMAT: 1A HOST: http://petstore.swagger.io/v2
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.
This API uses OAuth v2 Bearer Token for its authentication.
-
Request (application/json)
- Attributes (Pet)
-
Response 400
Invalid ID supplied
- Response 404
Pet not found
- Response 405
Validation exception
-
Request (application/json)
- Attributes (Pet)
-
Response 405
Invalid input
Multiple status values can be provided with comma seperated strings
-
Parameters
-
status (enum[string], required)
Status values that need to be considered for filter
- Members
available
pending
sold
- Members
-
-
Response 200 (application/json)
successful operation
+ Attributes (array[Pet])
- Response 400
Invalid status value
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
-
Parameters
-
tags (string, required)
Tags to filter by
-
-
Response 200 (application/json)
successful operation
+ Attributes (array[Pet])
- Response 400
Invalid tag value
- Parameters
-
petId (number, required)
ID of pet to return
-
Returns a single pet
- Response 200 (application/json)
successful operation
+ Attributes (Pet)
- Response 400
Invalid ID supplied
- Response 404
Pet not found
-
Parameters
-
name (string, optional)
Updated name of the pet
-
status (string, optional)
Updated status of the pet
-
-
Response 405
Invalid input
-
Parameters
- api_key (string, optional)
-
Response 400
Invalid pet value
- Parameters
-
petId (number, required)
ID of pet to update
-
-
Parameters
-
additionalMetadata (string, optional)
Additional data to pass to server
-
file (file, optional)
file to upload
-
-
Response 200 (application/json)
successful operation
+ Attributes (ApiResponse)
Returns a map of status codes to quantities
- Response 200
successful operation
+ Attributes (object)
-
Request (application/json)
- Attributes (Order)
-
Response 200 (application/json)
successful operation
+ Attributes (Order)
- Response 400
Invalid Order
- Parameters
-
orderId (number, required)
ID of pet that needs to be fetched
-
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
- Response 200 (application/json)
successful operation
+ Attributes (Order)
- Response 400
Invalid ID supplied
- Response 404
Order not found
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
- Response 400
Invalid ID supplied
- Response 404
Order not found
This can only be done by the logged in user.
-
Request (application/json)
- Attributes (User)
-
Response 500
successful operation
-
Request (application/json)
- Attributes (User)
-
Response 500
successful operation
-
Request (application/json)
- Attributes (User)
-
Response 500
successful operation
-
Parameters
-
username (string, required)
The user name for login
-
password (string, required)
The password for login in clear text
-
-
Response 200
successful operation
+ Attributes (string)
- Response 400
Invalid username/password supplied
- Response 500
successful operation
- Parameters
-
username (string, required)
The name that needs to be fetched. Use user1 for testing.
-
- Response 200 (application/json)
successful operation
+ Attributes (User)
- Response 400
Invalid username supplied
- Response 404
User not found
This can only be done by the logged in user.
-
Request (application/json)
- Attributes (User)
-
Response 400
Invalid user supplied
- Response 404
User not found
This can only be done by the logged in user.
- Response 400
Invalid username supplied
- Response 404
User not found
id
(number, optional)petId
(number, optional)quantity
(number, optional)shipDate
(string, optional)status
(enum, optional) - Order Statusapproved
delivered
placed
complete
(boolean, optional)
id
(number, optional)username
(string, optional)firstName
(string, optional)lastName
(string, optional)email
(string, optional)password
(string, optional)phone
(string, optional)userStatus
(number, optional) - User Status
id
(number, optional)name
(string, optional)
id
(number, optional)name
(string, optional)
id
(number, optional)category
(Category, optional)name
(string, required)photoUrls
(array[string], required)tags
(array[Tag], optional)status
(enum, optional) - pet status in the storeavailable
pending
sold
code
(number, optional)type
(string, optional)message
(string, optional)