Swagger Petstore (1.0.0)

Download OpenAPI specification:Download

E-mail: apiteam@swagger.io License: Apache 2.0 Terms of Service

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.

Find out more about Swagger

pet

Everything about your Pets

Find out more

Add a new pet to the store

Securitypetstore_auth
Request
Request Body schema:

Pet object that needs to be added to the store

id
integer <int64>
object (Category)
name
required
string
photoUrls
required
Array of strings
Array of objects (Tag)
status
string

pet status in the store

Enum: "available" "pending" "sold"
Responses
200

OK

405

Invalid input

post/pet
Request samples
{
  • "id": 0,
  • "category": {
    },
  • "name": "doggie",
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Update an existing pet

Securitypetstore_auth
Request
Request Body schema:

Pet object that needs to be added to the store

id
integer <int64>
object (Category)
name
required
string
photoUrls
required
Array of strings
Array of objects (Tag)
status
string

pet status in the store

Enum: "available" "pending" "sold"
Responses
200

OK

400

Invalid ID supplied

404

Pet not found

405

Validation exception

put/pet
Request samples
{
  • "id": 0,
  • "category": {
    },
  • "name": "doggie",
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Securitypetstore_auth
Request
query Parameters
status
required
Array of strings

Status values that need to be considered for filter

Items Enum: "available" "pending" "sold"
Responses
200

successful operation

400

Invalid status value

get/pet/findByStatus
Response samples
No sample

Finds Pets by tagsDeprecated

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

Securitypetstore_auth
Request
query Parameters
tags
required
Array of strings

Tags to filter by

Responses
200

successful operation

400

Invalid tag value

get/pet/findByTags
Response samples
No sample

Find pet by ID

Returns a single pet

Securityapi_key
Request
path Parameters
petId
required
integer <int64>

ID of pet to return

Responses
200

successful operation

400

Invalid ID supplied

404

Pet not found

get/pet/{petId}
Response samples
No sample

Updates a pet in the store with form data

Securitypetstore_auth
Request
path Parameters
petId
required
integer <int64>

ID of pet that needs to be updated

Request Body schema: application/x-www-form-urlencoded
name
string

Updated name of the pet

status
string

Updated status of the pet

Responses
200

OK

405

Invalid input

post/pet/{petId}
Request samples
application/x-www-form-urlencoded
name=string&status=string

Deletes a pet

Securitypetstore_auth
Request
path Parameters
petId
required
integer <int64>

Pet id to delete

header Parameters
api_key
string
Responses
200

OK

400

Invalid ID supplied

404

Pet not found

delete/pet/{petId}

uploads an image

Securitypetstore_auth
Request
path Parameters
petId
required
integer <int64>

ID of pet to update

Request Body schema: multipart/form-data
additionalMetadata
string

Additional data to pass to server

file
string <binary>

file to upload

Responses
200

successful operation

post/pet/{petId}/uploadImage
Response samples
application/json
{
  • "code": 0,
  • "type": "string",
  • "message": "string"
}