All pages
Powered by GitBook
1 of 1

Loading...

API blocks

A first block:

Webhooks :

Models:

newPet

Payload
idinteger · int64Required
namestringRequired
tagstringOptional
Responses
200

Return a 200 status to indicate that the data was received successfully

Payload

Add a new pet to the store.

post

Add a new pet to the store.

Authorizations
Body

Update an existing pet.

put

Update an existing pet by Id.

Authorizations
Body

Finds Pets by status.

get

Multiple status values can be provided with comma separated strings.

Authorizations

Deletes a pet.

delete

Delete a pet.

Authorizations
idinteger · int64OptionalExample: 10
namestringRequiredExample: doggie
photoUrlsstring[]Required
statusstring · enumOptional

pet status in the store

Possible values:
Responses
200

Successful operation

400

Invalid input

422

Validation exception

default

Unexpected error

post
POST /api/v3/pet HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}
idinteger · int64OptionalExample: 10
namestringRequiredExample: doggie
photoUrlsstring[]Required
statusstring · enumOptional

pet status in the store

Possible values:
Responses
200

Successful operation

400

Invalid ID supplied

404

Pet not found

422

Validation exception

default

Unexpected error

put
PUT /api/v3/pet HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}
Query parameters
statusstring · enumOptional

Status values that need to be considered for filter

Default: availablePossible values:
Responses
200

successful operation

400

Invalid status value

default

Unexpected error

get
GET /api/v3/pet/findByStatus HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Path parameters
petIdinteger · int64Required

Pet id to delete

Header parameters
api_keystringOptional
Responses
200

Pet deleted

400

Invalid pet value

default

Unexpected error

delete
DELETE /api/v3/pet/{petId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

{
  "id": 1,
  "name": "text",
  "tag": "text"
}
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}
[
  {
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }
]