Start building modern documentation site in 4 steps - Docuo

Documentation - Docuo

Introduction

Basic features

Overview

Quickstart

Set up your first project

Development

Configuration

Getting started

Sidebar

Multi-instance

Versioning

Internationalization

Managing docs

Components

Markdown Editor

VS Code extension

Editing docs

Customize with json file

Customize through platform

Custom domain

Customizing

Make an update

Activity history

Project settings

Updating website

Account settings

Workspace settings

Account management

Search

Analytics

Engaging users

Setup OpenAPI

Writing OpenAPI

Advanced Features

Add a new pet to the store

Create user

Creates list of users with given input array

Creates list of users with given input list

Delete purchase order by ID

Delete user

Deletes a pet

Find pet by ID

Find purchase order by ID

Finds Pets by status

Finds Pets by tags

Get user by user name

Logs out current logged in user session

Logs user into the system

New pet

Place an order for a pet

Returns pet inventories by status

Subscribe to the Store events

Update an existing pet

Updated user

Updates a pet in the store with form data

uploads an image

OpenAPI Demo

Using OpenAPI

This can only be done by the logged in user.


<h1 className={"openapi__heading"}>Updated user</h1>

<MethodEndpoint method={"put"} path={"/user/{username}"}></MethodEndpoint>


This can only be done by the logged in user.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"username","in":"path","description":"name that need to be deleted","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details>
<MimeTabs className={"openapi-tabs__mime request"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div className={"body-description-container"}><div className={"body-description"}>Updated user object</div></div><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>pet</strong><span className={"schema-name"}> object</span></summary><div className={"schema-description-container"}></div><div className={"oneof-container"}><span className={"oneof-label badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Pet"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>category</strong><span className={"openapi-schema__name"}> Category</span></span></summary><div className={"schema-description-container"}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"description":"Category name","type":"string","minLength":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sub</strong><span className={"openapi-schema__name"}> object</span></span></summary><div className={"schema-description-container"}><div className={"schema-description"}>Test Sub Category</div><SchemaItem collapsible={false} name={"prop1"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Dumb Property"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name given to a pet","type":"string","example":"Guru"}}></SchemaItem><SchemaItem collapsible={false} name={"photoUrls"} required={true} schemaName={"url[]"} qualifierMessage={"**Possible values:** `<= 20`"} schema={{"description":"The list of URL to a cute photos featuring pet","type":"array","maxItems":20,"xml":{"name":"photoUrl","wrapped":true},"items":{"type":"string","format":"url"}}}></SchemaItem><SchemaItem collapsible={false} name={"friend"} required={false} schemaName={"circular(Pet)"} qualifierMessage={undefined} schema={{}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>tags</strong><span className={"openapi-schema__name"}> Tag[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div className={"schema-description-container"}><div className={"schema-description"}>**Possible values:** `>= 1`</div><div className={"schema-description"}>Tags attached to the pet</div><li className={"opening-array-bracket-container"}><div className={"opening-array-bracket"}><span className={"opening-array-bracket_text"}>Array</span><span className={"opening-array-bracket_symbol"}>[</span></div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"description":"Tag name","type":"string","minLength":1}}></SchemaItem><li className={"closing-array-bracket-container"}><div className={"closing-array-bracket"}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"} schema={{"type":"string","description":"Pet status in the store","enum":["available","pending","sold"]}}></SchemaItem><div className={"openapi-discriminator__item openapi-schema__list-item"}><div><span className={"openapi-schema__container"}><strong className={"openapi-discriminator__name openapi-schema__property"}>petType</strong><span className={"openapi-schema__name"}> string</span></span><div style={{"paddingLeft":"1rem"}}>**Possible values:** [`cat`, `dog`, `bee`]</div><div style={{"paddingLeft":"1rem"}}>Type of a pet</div><DiscriminatorTabs className={"openapi-tabs__discriminator"}><TabItem label={"cat"} value={"0-item-discriminator"}><SchemaItem collapsible={false} name={"huntingSkill"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clueless`, `lazy`, `adventurous`, `aggressive`]"} schema={{"type":"string","description":"The measured skill for hunting","default":"lazy","example":"adventurous","enum":["clueless","lazy","adventurous","aggressive"]}}></SchemaItem></TabItem><TabItem label={"dog"} value={"1-item-discriminator"}><SchemaItem collapsible={false} name={"packSize"} required={true} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","format":"int32","description":"The size of the pack the dog is from","default":1,"minimum":1}}></SchemaItem></TabItem><TabItem label={"bee"} value={"2-item-discriminator"}><SchemaItem collapsible={false} name={"honeyPerDay"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Average amount of honey produced per day in ounces","example":3.14,"multipleOf":0.01}}></SchemaItem></TabItem></DiscriminatorTabs></div></div></TabItem><TabItem label={"Tag"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"description":"Tag name","type":"string","minLength":1}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 4 characters`"} schema={{"description":"User supplied username","type":"string","minLength":4,"example":"John78"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"description":"User first name","type":"string","minLength":1,"example":"John"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"description":"User last name","type":"string","minLength":1,"example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"description":"User email address","type":"string","format":"email","example":"john.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"password"} required={false} schemaName={"password"} qualifierMessage={"**Possible values:** `>= 8 characters`, Value must match regular expression `/(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/`"} schema={{"type":"string","description":"User password, MUST contain a mix of upper and lower case letters, as well as digits","format":"password","minLength":8,"pattern":"/(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/","example":"drowssaP123"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `/^\\+(?:[0-9]-?){6,14}[0-9]$/`"} schema={{"description":"User phone number in international format","type":"string","pattern":"/^\\+(?:[0-9]-?){6,14}[0-9]$/","example":"+1-202-555-0192"}}></SchemaItem><SchemaItem collapsible={false} name={"userStatus"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"User status","type":"integer","format":"int32"}}></SchemaItem></ul></details></TabItem></MimeTabs>
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"400"} value={"400"}><div>Invalid user supplied</div><div></div></TabItem><TabItem label={"404"} value={"404"}><div>User not found</div><div></div></TabItem></ApiTabs></div></div>
      

Request

Updated user

https://petstore.swagger.io/v2/user/:username

Request

Path Parameters

Body

Responses

Updated user

https://petstore.swagger.io/v2/user/:username

Request

Path Parameters

Body

Responses​

Responses