API blocks

A first block:

Add a new pet to the store.

post

Add a new pet to the store.

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

pet status in the store

Possible values:
Responses
200
Successful operation
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"
}
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Update an existing pet.

put

Update an existing pet by Id.

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

pet status in the store

Possible values:
Responses
200
Successful operation
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"
}
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Finds Pets by status.

get

Multiple status values can be provided with comma separated strings.

Authorizations
Query parameters
statusstring · enumOptional

Status values that need to be considered for filter

Default: availablePossible values:
Responses
200
successful operation
get
GET /api/v3/pet/findByStatus HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Deletes a pet.

delete

Delete a pet.

Authorizations
Path parameters
petIdinteger · int64Required

Pet id to delete

Header parameters
api_keystringOptional
Responses
200
Pet deleted
delete
DELETE /api/v3/pet/{petId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Webhooks :

newPet

Payload
idinteger · int64Required
namestringRequired
tagstringOptional
Responses
200
Return a 200 status to indicate that the data was received successfully

Payload

{
  "id": 1,
  "name": "text",
  "tag": "text"
}

Models:

PreviousPage linksNextMath

Last updated