v1.0.0OpenAPI 3.0.3

Petstore (Swagger 2.0)

Endpoints: 5
Groups: 1
Models: 3

pets

List pets

get/pets

operationId: listPets

Query parameters

limitinteger<int32>

≥ 1

Default: 20

tagsarray<string>

Example: ["cat"]

Responses

Headers

X-Totalinteger

Total count

Array item: Pet

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

curl --request GET \
  --url 'https://petstore.example.com/v2/pets'

[
  {
    "id": 1,
    "name": "Rex"
  }
]

Create pet

post/pets

operationId: createPet

Requirespetstore_auth (write:pets)

Request body

required

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

Responses

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

curl --request POST \
  --url 'https://petstore.example.com/v2/pets' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "name": "string",
  "kind": "string",
  "owner": {
    "name": "string"
  },
  "nickname": "string"
}'

{
  "id": 0,
  "name": "string",
  "kind": "string",
  "owner": {
    "name": "string"
  },
  "nickname": "string"
}

Get pet

get/pets/{petId}

operationId: getPet

Path parameters

petIdinteger<int64>required

Responses

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

curl --request GET \
  --url 'https://petstore.example.com/v2/pets/0'

{
  "id": 0,
  "name": "string",
  "kind": "string",
  "owner": {
    "name": "string"
  },
  "nickname": "string"
}

Update pet

put/pets/{petId}

operationId: updatePet

Path parameters

petIdinteger<int64>required

Request body

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

Responses

curl --request PUT \
  --url 'https://petstore.example.com/v2/pets/0' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "name": "string",
  "kind": "string",
  "owner": {
    "name": "string"
  },
  "nickname": "string"
}'

Upload photo

post/pets/{petId}/photo

operationId: uploadPhoto

Path parameters

petIdintegerrequired

Request body

filestring<binary>required

Photo

captionstring

Responses

curl --request POST \
  --url 'https://petstore.example.com/v2/pets/0/photo' \
  --form 'file=@./file.bin' \
  --form-string 'caption=string'

Models

Pet

idinteger<int64>required

namestringrequired

kindstring

Owner

nicknamestringnullable

Owner

namestring

Error

messagestring