All pages
Powered by GitBook
1 of 27

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Blocks

Hints

Colors

Info hints are great for showing general information, or providing tips and tricks.

Success hints are good for showing positive actions or achievements.

Warning hints are good for showing important information or non-critical warnings.

Danger hints are good for highlighting destructive actions or raising attention to critical information.

With blocks in it

First paragraph

Second paragraph

  • List item

  • Second list item

With a divider:


After the divider

With a header

This is the hint content after the header

And with a link !

Annotations

This paragraph contains an . It can be opened by clicking it.

In codeblocks

// Some code
and an .

Integrations

A mermaid block:

A GitHub file:

A linear issue

A mailchimp block

An Arcade block:

Tabs

A single tab:

Tab with content:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

This tab contains headings that can be linked to:

First heading

Content

Second heading

Content

Tab with many long tab titles:

Links & tabs

Individual tabs can be linked or .

Code

Code block with lines and no wrapping

Code block with line numbers and wrapping

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Second Tab
Mauris dolor diam
Code block with wrapping but no line numbers

Code block with full-width option

function CodeHighlightLine(props: {
    block: DocumentBlockCode;
    line: HighlightLine;
    lineIndex: number;
    isLast: boolean;
    withLineNumbers: boolean;
    withWrap: boolean;
    context: ContentRefContext;
}) {
    const { block, line, isLast, withLineNumbers, context } = props;

    return (
        <span
            className={tcls(
                'flex',
                'flex-row',
                'px-4',
                line.highlighted ? 'bg-slate-200' : null,
                withLineNumbers
                    ? [
                          'before:shrink-0',
                          'before:absolute',
                          'before:left-0',
                          'before:pl-4',
                          line.highlighted ? 'before:bg-slate-200' : 'before:bg-slate-100',
                          'before:text-slate-400',
                          'before:content-[counter(line)]',
                          '[counter-increment:line]',
                          getLineNumberGutterWidth(block),
                      ]
                    : [],
            )}
        >
            <span className="flex-1">
                <CodeHighlightTokens tokens={line.tokens} context={context} />
                {isLast ? null : !withLineNumbers && line.tokens.length === 0 && 0 ? (
                    <span className="ew">{'\u200B'}</span>
                ) : (
                    '\n'
                )}
            </span>
        </span>
    );
}
function CodeHighlightLine(props: {
    block: DocumentBlockCode;
    line: HighlightLine;
    lineIndex: number;
    isLast: boolean;
    withLineNumbers: boolean;
    withWrap: boolean;
    context: ContentRefContext;
}) {
    const { block, line, isLast, withLineNumbers, context } = props;

    return (
        <span
            className={tcls(
                'flex',
                'flex-row',
                'px-4',
                line.highlighted ? 'bg-slate-200' : null,
                withLineNumbers
                    ? [
                          'before:shrink-0',
                          'before:absolute',
                          'before:left-0',
                          'before:pl-4',
                          line.highlighted ? 'before:bg-slate-200' : 'before:bg-slate-100',
                          'before:text-slate-400',
                          'before:content-[counter(line)]',
                          '[counter-increment:line]',
                          getLineNumberGutterWidth(block),
                      ]
                    : [],
            )}
        >
            <span className="flex-1">
                <CodeHighlightTokens tokens={line.tokens} context={context} />
                {isLast ? null : !withLineNumbers && line.tokens.length === 0 && 0 ? (
                    <span className="ew">{'\u200B'}</span>
                ) : (
                    '\n'
                )}
            </span>
        </span>
    );
}
function CodeHighlightLine(props: {
    block: DocumentBlockCode;
    line: HighlightLine;
    lineIndex: number;
    isLast: boolean;
    withLineNumbers: boolean;
    withWrap: boolean;
    context: ContentRefContext;
}) {
    const { block, line, isLast, withLineNumbers, context } = props;

    return (
        <span
            className={tcls(
                'flex',
                'flex-row',
                'px-4',
                line.highlighted ? 'bg-slate-200' : null,
                withLineNumbers
                    ? [
                          'before:shrink-0',
                          'before:absolute',
                          'before:left-0',
                          'before:pl-4',
                          line.highlighted ? 'before:bg-slate-200' : 'before:bg-slate-100',
                          'before:text-slate-400',
                          'before:content-[counter(line)]',
                          '[counter-increment:line]',
                          getLineNumberGutterWidth(block),
                      ]
                    : [],
            )}
        >
            <span className="flex-1">
                <CodeHighlightTokens tokens={line.tokens} context={context} />
                {isLast ? null : !withLineNumbers && line.tokens.length === 0 && 0 ? (
                    <span className="ew">{'\u200B'}</span>
                ) : (
                    '\n'
                )}
            </span>
        </span>
    );
}
// Some code

Tables

Basic text table

With header

A

Headings

Heading 1

Heading 2

Heading 3

Title 1

Title 2

Title 3

Heading centered

This text is also centered

Heading on the right

This text is also right

Expandables

Empty

This is an empty expandable (body)

With content

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Emojis

This text contains some 😇 emojis!!

Emojis can also be used in 🎉 headings!

Diversity: 👩

And other emojis: man detective🕵️, women detective🕵️‍♀️

B
C

A1

B1

C1

A2

B2

C2

A3

B3

C3

With header hidden

A1

B1

C1

A2

B2

C2

A3

B3

C3

With resized column (B being larger)

A
B
C

A1

B1

C1

A2

B2

C2

A3

B3

C3

With text alignment (A to the right, B centered, C to the left)

A
B
C

A1

B1

C1

Pasted right-aligned paragraph

Pasted right-aligned paragraph

Pasted right-aligned paragraph

Tables with different column types

Some intro text

A short oneA tag that is quite longAnother one

Short intro text

A short one

Another text

Another one

Table with full-width

A1

B1

C1

A2

B2

C2

A3

B3

C3

Table with ratings

Rating A
Rating B

R1

R2

R3

Table with files

An image file

16x16.png

An openAPI file

openapi.yaml

No file

Table with checkbox

Checkbox

Checked

Not checked

Checked

Table with content references

Link

Page

Text page

Page with emoji

🌍Page with emoji

Page with icon

Page with icon

A1

B1

C1

A2

B2

C2

A3

B3

C3

Block Images

Large image

Alignment

Image centered:

An image on the left:

An image on the right:

Alignment with caption

Image centered:

An image on the left:

An image on the right:

Cards

2 basic cards with text:

Cards with cover

Cards with centered text and images

Cards with different column types

Cards full-width

Cards with different column types and headers

Intro text
Enum values
Intro text
Enum values
Intro text
Enum values

Inline Images

his paragraph contains inline images, this first one was using the "original" size, and then this one is using the line size.

This image has intrinsic 400px width, but renders as 300px:

Some customers add Cards with inline images instead of Cover images. When they do, we should still respect the 300px width despite the Card being under 250px. The contents of the images should be centered.

Finally, we should make sure to render tiny inline images correctly:

11x11

16x16

22x22

Buttons

Some text with a button and

2 buttons next to each other:

With text alignment

Centeted:

On the right:

With icon

A button with an icon: it has a nice icon

Primary button
Secondary
Button 1
Button 2
New button
New button
16x16.png

Icons

This text contains some icons!!

Icons can also be used in headings!

Images in links should not zoom when clicked, for example .

Hello world

Bonjour le monde

Hola Mundo

Hello world

Bonjour le monde

Centered text

Text on the right

Hola Mundo

Hello world

Bonjour le monde

Some intro text

A short oneA tag that is quite longAnother one

Short intro text

A short one

Another text

Another one

Hello world

Bonjour le monde

Hola Mundo

Some intro text

A short oneA tag that is quite longAnother one

Short intro text

A short one

Another text

Another one
Cover
Cover
Cover
A caption that is longer than the image to test how the images is being positioned relative to it.
A caption that is longer than the image to test how the images is being positioned relative to it.
A caption that is longer than the image to test how the images is being positioned relative to it.

Links

Links

This is a link to a heading. This is a mention of a heading A heading.

This is a link to a heading in a different page. And this a mention Heading 3.

This is a link to a page. And this is a mention: Text page

This is a link to the current space. And this is a mention Test GitBook Open

This is a (public). And this is a mention

This is a . And this is a mention

This is a . And this is a mention .

This is a . And this is a mention .

A heading

API blocks

A first block:

Webhooks :

Models:

Marks

The following text is bold and italic. Styles can also be combined.

Keyboard maks X + Y + Ctrl + ⌘

Other styles includes code text and colored text.

And superscript and subscript.

Colors

Text colors:

  • Purple

  • Blue

  • Red

  • Orange

Background colors:

  • Purple

  • Blue

  • Red

  • Orange

Combined:

  • Purple

  • Blue

  • Red

  • Orange

Yellow

  • Green

  • Primary

  • Info

  • Success

  • Warning

  • Danger

  • Yellow

  • Green

  • Primary

  • Info

  • Success

  • Warning

  • Danger

  • Yellow

  • Green

  • Primary

  • Info

  • Success

  • Warning

  • Danger

  • Math

    A math block that should render with KaTeX:

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

    A math block that should be rendered with MathJax:

    A math inline with KaTex: f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξx and one with MathJax

    Another one with MathJax:

    And a bigger one with KaTeX:

    1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π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} } } }(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​

    Long inline math 1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π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} } } }(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​

    Files

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

    20KB
    openapi.yaml
    454KB
    Screenshot 2024-02-16 at 10.54.58.png
    image

    File blocks can also have a caption:

    613B
    22x22.png
    image
    This is a small version of the GitBook logo
    398B
    10x10.png
    image
    Event smaller

    Embeds

    Embed as a card, handled by an integration:

    Embed as a card, not handled by an integration

    Embed of a youtube video

    Embed with a caption

    Embed full-width

    Expressions

    TEST_1:

    TEST_2:

    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!

    Lists

    Unordered list

    • First item

    • Second item

      • First nested item

        • Second nested item

    • Third item

    Ordered list

    1. First item

    2. Second item

      1. First nested item

        1. Second nested item

    Tasks

    Mix

    1. Ordered list item

      • Unordered list item

    UL With blocks

    • List item starting with a heading

      A paragraph below it.

    • Text before code block

    OL With blocks

    1. List item starting with a heading

      A paragraph below it.

    2. Text before code block

    Tasks With blocks

    Columns

    Left hand side!

    Middle column

    Right hand side!

    Test different widths

    Ut ligula ipsum, viverra vel hendrerit vitae

    Donec eu augue in dui test ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Test different widths

    Ut ligula ipsum, viverra vel hendrerit vitae

    Donec eu augue in dui test ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Ut ligula ipsum, viverra vel hendrerit vitae

    Donec eu augue in dui test ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Vertical alignment - top

    Donec eu augue in dui convallis ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Ut ligula ipsum, viverra vel hendrerit vitae

    Donec eu augue in dui test ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Vertical alignment - centered

    Ut ligula ipsum, viverra vel hendrerit vitae

    Donec eu augue in dui test ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.

    Vertical alignment - bottom

    Third item

    code block
    a second line
    Directly, a code block
    code block
    a second line
    Directly, a code block
    code block
    a second line
    Directly, a code block
    Donec eu augue in dui convallis ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.
    Donec eu augue in dui convallis ultrices id ac sapien. Phasellus mauris lorem, ullamcorper ac elementum sit amet, facilisis sit amet sem.
    Learn more
    Learn more
    Learn more

    Updates

    Text before the updates

    Text between the updates

    Page links

    Link to another page

    Link to a file

    20KB
    openapi.yaml

    Link to another space

    Link to a private space

    Blocks
    🌍Page with emoji
    Page with icon
    Render integration blocks
    RND-1853•Done
    Sign up to our mailing list to receive updates!
    https://github.com/GitbookIO/gitbook-open/blob/main/package.json#L2-L3
        "name": "gitbook",
        "version": "0.1.0",

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

    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

    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

    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

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

    No content

    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"
    }
    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"
    }
    GET /api/v3/pet/findByStatus HTTP/1.1
    Host: 
    Authorization: Bearer YOUR_OAUTH2_TOKEN
    Accept: */*
    
    DELETE /api/v3/pet/{petId} HTTP/1.1
    Host: 
    Authorization: Bearer YOUR_OAUTH2_TOKEN
    Accept: */*
    
    link to a different space
    Public Changelog
    Not found
    GitHubWikipedia
    A youtube video
    GitBook Documentation
    link to a private space
    space
    link to a page in a private space
    link to a page in a public space
    space
    Logo