E2E Tests GitBook Open
  • Welcome
  • Text page
    • Long text thisisaveryyyylonnnnngwordthatisnotrealisic butit'sok
  • Empty page
  • Page options
    • Page no index
      • Descendant of page no index
    • Page no robots index
      • Descendant of page no robots index
    • Page without TOC
    • Page with description
    • Page with cover
    • Page with cover and no TOC
    • Page with hero cover
    • 🌍Page with emoji
    • Page with icon
      • Cake
      • Ice cream
      • Burger
      • Food
  • Blocks
    • Code
    • Annotations
    • Tabs
    • Hints
    • Integrations
    • Tables
    • Cards
    • Headings
    • Expandables
    • Inline Images
    • Block Images
    • Marks
    • Emojis
    • Links
    • Page links
    • API blocks
    • Math
    • Files
    • Embeds
    • Lists
    • Stepper
Powered by GitBook
Export as PDF
  1. Blocks

API blocks

PreviousPage linksNextMath

Last updated 1 year ago

A first block:

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
400
Invalid status value
default
Unexpected error
get
GET /api/v3/pet/findByStatus HTTP/1.1
Host: 
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
400
Invalid pet value
default
Unexpected error
delete
DELETE /api/v3/pet/{petId} HTTP/1.1
Host: 
Accept: */*

No content
On this page
  • POSTAdd a new pet to the store.
  • PUTUpdate an existing pet.
  • GETFinds Pets by status.
  • DELETEDeletes a pet.

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
400
Invalid input
422
Validation exception
default
Unexpected error
post
POST /api/v3/pet HTTP/1.1
Host: 
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
400
Invalid ID supplied
404
Pet not found
422
Validation exception
default
Unexpected error
put
PUT /api/v3/pet HTTP/1.1
Host: 
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"
}