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
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"
}

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
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
delete
DELETE /api/v3/pet/{petId} HTTP/1.1
Host: 
Accept: */*

No content

Math

A math block that should render with KaTeX:

f(x)=xe2piiξxf(x) = x * e^{2 pi i \xi x}

A math block that should be rendered with MathJax:

σi,BTC=min($9600, $2500)

A math inline with KaTex: f(x)=xe2piiξxf(x) = x * e^{2 pi i \xi x} and one with MathJax σi,BTC=min($9600, $2500)

Another one with MathJax:

Hourly Funding Payment=Position Notional Value×Funding Rate 

And a bigger one with KaTeX:

1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+\displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }

Long inline math 1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+1(ϕ5ϕ)e25π=1+e2π1+e4π1+e6π1+e8π1+\displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }

Files

File blocks reference a file and are used to help users download specific files.

File blocks can also have a caption:

This is a small version of the GitBook logo
Event smaller

Embeds

Embed as a card, handled by an integration:

https://github.com/GitbookIO/gitbook

Embed as a card, not handled by an integration

Embed of a youtube video

Embed with a caption

A youtube video

Embed full-width

Lists

Unordered list

Ordered list

  1. First item

  2. Second item

    1. First nested item

      1. Second nested item

  3. Third item

Tasks

Mix

  1. Ordered list item

    • Unordered list item

UL With blocks

OL With blocks

  1. List item starting with a heading

    A paragraph below it.

  2. Text before code block

    code block
    a second line
  3. Directly, a code block

Tasks With blocks

Stepper

1

First step

Content of the step

With another line, and an image

2

Second step

This is the second step

3

This is the first step

And it's good!

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"
}
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"
}
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"
  }
]