Swagger Petstore (1.0.5) swagger 2 source

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.

Authentication

API key

An API key is a special token (api_key) that you need to provide in header when making API calls, Like: { api_key: "TOKEN_VALUE" }

OAuth 2.0

OAuth is an open standard for access delegation, commonly used as a way for Internet users to grant websites or applications access to their information on other websites but without giving them the passwords

Oauth Server Details

Authorization URL https://petstore.swagger.io/oauth/authorize
Token URL
Flow implicit

Scopes

read:pets read your pets
write:pets modify pets in your account

pet

uploads an image

post https://petstore.swagger.io/v2 /pet/{petId}/uploadImage Try Out

path

petId REQUIRED

integer

ID of pet to update

formData

additionalMetadata OPTIONAL

string

Additional data to pass to server

file OPTIONAL

file

file to upload

200

successful operation

Example Value | Model 

{
    "code": "",
    "type": "",
    "message": ""
}
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/pet/{petId}/uploadImage \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --form 'additionalMetadata=Something' \
  --form 'file=@FILE'

Add a new pet to the store

post https://petstore.swagger.io/v2 /pet Try Out

body

body REQUIRED

Pet object that needs to be added to the store

Example Value | Model 

{
    "id": "",
    "category": {
        "id": "",
        "name": ""
    },
    "name": "doggie",
    "photoUrls": [
        ""
    ],
    "tags": [
        {
            "id": "",
            "name": ""
        }
    ],
    "status": ""
}
405

Invalid input

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/pet \
  --body '{"id":"","category":{"id":"","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"","name":""}],"status":""}'

Update an existing pet

put https://petstore.swagger.io/v2 /pet Try Out

body

body REQUIRED

Pet object that needs to be added to the store

Example Value | Model 

{
    "id": "",
    "category": {
        "id": "",
        "name": ""
    },
    "name": "doggie",
    "photoUrls": [
        ""
    ],
    "tags": [
        {
            "id": "",
            "name": ""
        }
    ],
    "status": ""
}
400

Invalid ID supplied

Example Value | Model 

""
404

Pet not found

Example Value | Model 

""
405

Validation exception

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request PUT \
  --url https://petstore.swagger.io/v2/pet \
  --body '{"id":"","category":{"id":"","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"","name":""}],"status":""}'

Finds Pets by status

Multiple status values can be provided with comma separated strings

get https://petstore.swagger.io/v2 /pet/findByStatus Try Out

query

status REQUIRED

array

Possible Value: available, pending, sold

Status values that need to be considered for filter

200

successful operation

Example Value | Model 

""
400

Invalid status value

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/pet/findByStatus?status=

Finds Pets by tags (Deprecated)

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

get https://petstore.swagger.io/v2 /pet/findByTags Try Out

query

tags REQUIRED

array

Tags to filter by

200

successful operation

Example Value | Model 

""
400

Invalid tag value

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/pet/findByTags?tags=

Find pet by ID

Returns a single pet

get https://petstore.swagger.io/v2 /pet/{petId} Try Out

path

petId REQUIRED

integer

ID of pet to return

200

successful operation

Example Value | Model 

{
    "id": "",
    "category": {
        "id": "",
        "name": ""
    },
    "name": "doggie",
    "photoUrls": [
        ""
    ],
    "tags": [
        {
            "id": "",
            "name": ""
        }
    ],
    "status": ""
}
400

Invalid ID supplied

Example Value | Model 

""
404

Pet not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/pet/{petId}

Updates a pet in the store with form data

post https://petstore.swagger.io/v2 /pet/{petId} Try Out

path

petId REQUIRED

integer

ID of pet that needs to be updated

formData

name OPTIONAL

string

Updated name of the pet

status OPTIONAL

string

Updated status of the pet

405

Invalid input

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/pet/{petId} \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --form 'name=Something' \
  --form 'status=Something'

Deletes a pet

delete https://petstore.swagger.io/v2 /pet/{petId} Try Out

header

api_key OPTIONAL

string

path

petId REQUIRED

integer

Pet id to delete

400

Invalid ID supplied

Example Value | Model 

""
404

Pet not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request DELETE \
  --url https://petstore.swagger.io/v2/pet/{petId} \
  --header 'api_key: Something'

store

Place an order for a pet

post https://petstore.swagger.io/v2 /store/order Try Out

body

body REQUIRED

order placed for purchasing the pet

Example Value | Model 

{
    "id": "",
    "petId": "",
    "quantity": "",
    "shipDate": "",
    "status": "",
    "complete": ""
}
200

successful operation

Example Value | Model 

{
    "id": "",
    "petId": "",
    "quantity": "",
    "shipDate": "",
    "status": "",
    "complete": ""
}
400

Invalid Order

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/store/order \
  --body '{"id":"","petId":"","quantity":"","shipDate":"","status":"","complete":""}'

Find purchase order by ID

For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions

get https://petstore.swagger.io/v2 /store/order/{orderId} Try Out

path

orderId REQUIRED

integer

ID of pet that needs to be fetched

200

successful operation

Example Value | Model 

{
    "id": "",
    "petId": "",
    "quantity": "",
    "shipDate": "",
    "status": "",
    "complete": ""
}
400

Invalid ID supplied

Example Value | Model 

""
404

Order not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/store/order/{orderId}

Delete purchase order by ID

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

delete https://petstore.swagger.io/v2 /store/order/{orderId} Try Out

path

orderId REQUIRED

integer

ID of the order that needs to be deleted

400

Invalid ID supplied

Example Value | Model 

""
404

Order not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request DELETE \
  --url https://petstore.swagger.io/v2/store/order/{orderId}

Returns pet inventories by status

Returns a map of status codes to quantities

get https://petstore.swagger.io/v2 /store/inventory Try Out

200

successful operation

Example Value | Model 

{}
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/store/inventory

user

Creates list of users with given input array

post https://petstore.swagger.io/v2 /user/createWithArray Try Out

body

body REQUIRED

List of user object

Example Value | Model 

""
default

successful operation

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/user/createWithArray \
  --body '""'

Creates list of users with given input array

post https://petstore.swagger.io/v2 /user/createWithList Try Out

body

body REQUIRED

List of user object

Example Value | Model 

""
default

successful operation

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/user/createWithList \
  --body '""'

Get user by user name

get https://petstore.swagger.io/v2 /user/{username} Try Out

path

username REQUIRED

string

The name that needs to be fetched. Use user1 for testing.

200

successful operation

Example Value | Model 

{
    "id": "",
    "username": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "password": "",
    "phone": "",
    "userStatus": ""
}
400

Invalid username supplied

Example Value | Model 

""
404

User not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/user/{username}

Updated user

This can only be done by the logged in user.

put https://petstore.swagger.io/v2 /user/{username} Try Out

path

username REQUIRED

string

name that need to be updated

body

body REQUIRED

Updated user object

Example Value | Model 

{
    "id": "",
    "username": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "password": "",
    "phone": "",
    "userStatus": ""
}
400

Invalid user supplied

Example Value | Model 

""
404

User not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request PUT \
  --url https://petstore.swagger.io/v2/user/{username} \
  --body '{"id":"","username":"","firstName":"","lastName":"","email":"","password":"","phone":"","userStatus":""}'

Delete user

This can only be done by the logged in user.

delete https://petstore.swagger.io/v2 /user/{username} Try Out

path

username REQUIRED

string

The name that needs to be deleted

400

Invalid username supplied

Example Value | Model 

""
404

User not found

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request DELETE \
  --url https://petstore.swagger.io/v2/user/{username}

Logs user into the system

get https://petstore.swagger.io/v2 /user/login Try Out

query

username REQUIRED

string

The user name for login

password REQUIRED

string

The password for login in clear text

200

successful operation

Example Value | Model 

""

Headers

X-Expires-After string

date in UTC when token expires

X-Rate-Limit integer

calls per hour allowed by the user

400

Invalid username/password supplied

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/user/login?username=Something&password=Something

Logs out current logged in user session

get https://petstore.swagger.io/v2 /user/logout Try Out

default

successful operation

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request GET \
  --url https://petstore.swagger.io/v2/user/logout

Create user

This can only be done by the logged in user.

post https://petstore.swagger.io/v2 /user Try Out

body

body REQUIRED

Created user object

Example Value | Model 

{
    "id": "",
    "username": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "password": "",
    "phone": "",
    "userStatus": ""
}
default

successful operation

Example Value | Model 

""
cURL JavaScript Node Python 
curl --request POST \
  --url https://petstore.swagger.io/v2/user \
  --body '{"id":"","username":"","firstName":"","lastName":"","email":"","password":"","phone":"","userStatus":""}'