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

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions


<h1 className={"openapi__heading"}>Find purchase order by ID</h1>

<MethodEndpoint method={"get"} path={"/store/order/{orderId}"}></MethodEndpoint>


For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
## 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":"orderId","in":"path","description":"ID of pet that needs to be fetched","required":true,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":5}}}></ParamsItem></ul></div></details>
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>successful operation</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><ul className={"response-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","readOnly":true,"title":"Id"}}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","readOnly":true,"title":"Id"}}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","format":"int32","minimum":1,"default":1}}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Estimated ship date","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} schema={{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whenever order was completed or not","type":"boolean","default":false,"readOnly":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": 0,\n  \"petId\": 0,\n  \"quantity\": 1,\n  \"shipDate\": \"2024-04-10T08:56:21.983Z\",\n  \"status\": \"placed\",\n  \"complete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><ul className={"response-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","readOnly":true,"title":"Id"}}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","readOnly":true,"title":"Id"}}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","format":"int32","minimum":1,"default":1}}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Estimated ship date","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} schema={{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whenever order was completed or not","type":"boolean","default":false,"readOnly":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"<root>\n  <id>0</id>\n  <petId>0</petId>\n  <quantity>1</quantity>\n  <shipDate>2024-04-10T08:56:21.983Z</shipDate>\n  <status>placed</status>\n  <complete>false</complete>\n</root>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>Invalid ID supplied</div><div></div></TabItem><TabItem label={"404"} value={"404"}><div>Order not found</div><div></div></TabItem></ApiTabs></div></div>
      

Request

Find purchase order by ID

https://petstore.swagger.io/v2/store/order/:orderId

Request

Path Parameters

Responses

Find purchase order by ID

https://petstore.swagger.io/v2/store/order/:orderId

Request

Path Parameters

Responses​

Responses