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


<h1 className={"openapi__heading"}>Subscribe to the Store events</h1>

<MethodEndpoint method={"post"} path={"/store/subscribe"}></MethodEndpoint>


Add subscription for a store events
## Request
<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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"callbackUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"This URL will be called by the server when the desired event will occur","example":"https://myserver.com/send/callback/here"}}></SchemaItem><SchemaItem collapsible={false} name={"eventName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`orderInProgress`, `orderShipped`, `orderDelivered`]"} schema={{"type":"string","description":"Event name for the subscription","enum":["orderInProgress","orderShipped","orderDelivered"],"example":"orderInProgress"}}></SchemaItem></ul></details></TabItem></MimeTabs>
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>Subscription added</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={"subscriptionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AAA-123-BBB-456"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"subscriptionId\": \"AAA-123-BBB-456\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
<div><div className={"openapi__divider"}></div><h2 id={"callbacks"}>Callbacks</h2><OperationTabs className={"openapi-tabs__operation"}><TabItem label={"POST orderInProgress"} value={"post-orderInProgress"}><MethodEndpoint method={"post"} path={"{$request.body#/callbackUrl}?event={$request.body#/eventName}"}></MethodEndpoint>A callback triggered every time an Order is updated status to "inProgress" (Description)<MimeTabs className={"openapi-tabs__mime request"} schemaType={"request"}><TabItem label={"application/json"} value={"application/json"}><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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T16:46:45Z"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"inProgress"}}></SchemaItem></ul></details></TabItem><TabItem label={"application/xml"} value={"application/xml"}><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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={"Callbacks Responses"} id={"callbacks-responses"}><TabItem label={"200"} value={"200"}><div>Callback successfully processed and no retries will be performed</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={"someProp"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"someProp\": \"123\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"299"} value={"299"}><div>Response for cancelling subscription</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>Callback processing failed and retries will be performed</div><div></div></TabItem></ApiTabs></div></div></TabItem><TabItem label={"PUT orderInProgress"} value={"put-orderInProgress"}><MethodEndpoint method={"put"} path={"{$request.body#/callbackUrl}?event={$request.body#/eventName}"}></MethodEndpoint>Order in Progress (Only Description)<MimeTabs className={"openapi-tabs__mime request"} schemaType={"request"}><TabItem label={"application/json"} value={"application/json"}><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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T16:46:45Z"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"inProgress"}}></SchemaItem></ul></details></TabItem><TabItem label={"application/xml"} value={"application/xml"}><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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={"Callbacks Responses"} id={"callbacks-responses"}><TabItem label={"200"} value={"200"}><div>Callback successfully processed and no retries will be performed</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={"someProp"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"someProp\": \"123\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div></TabItem><TabItem label={"POST orderShipped"} value={"post-orderShipped"}><MethodEndpoint method={"post"} path={"{$request.body#/callbackUrl}?event={$request.body#/eventName}"}></MethodEndpoint>A callback triggered every time an Order is shipped to the recipient<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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T16:46:45Z"}}></SchemaItem><SchemaItem collapsible={false} name={"estimatedDeliveryDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-11-11T16:00:00Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={"Callbacks Responses"} id={"callbacks-responses"}><TabItem label={"200"} value={"200"}><div>Callback successfully processed and no retries will be performed</div><div></div></TabItem></ApiTabs></div></div></TabItem><TabItem label={"POST orderDelivered"} value={"post-orderDelivered"}><MethodEndpoint method={"post"} path={"http://notificationServer.com?url={$request.body#/callbackUrl}&event={$request.body#/eventName}"}></MethodEndpoint>A callback triggered every time an Order is delivered to the recipient<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></summary><ul className={"request-schema-first-body-node-container"}><SchemaItem collapsible={false} name={"orderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T16:46:45Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={"Callbacks Responses"} id={"callbacks-responses"}><TabItem label={"200"} value={"200"}><div>Callback successfully processed and no retries will be performed</div><div></div></TabItem></ApiTabs></div></div></TabItem></OperationTabs></div>
      

Request

Subscribe to the Store events

https://petstore.swagger.io/v2/store/subscribe

Request

Body

Responses

Callbacks

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Body

Callbacks Responses

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Body

Callbacks Responses

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Callbacks Responses

https://petstore.swagger.io/v2http://notificationServer.com?url={$request.body#/callbackUrl}&event={$request.body#/eventName}

Body

Callbacks Responses

Subscribe to the Store events

https://petstore.swagger.io/v2/store/subscribe

Request

Body

Responses​

Callbacks

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Body

Callbacks Responses​

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Body

Callbacks Responses​

https://petstore.swagger.io/v2{$request.body#/callbackUrl}?event={$request.body#/eventName}

Body

Callbacks Responses​

https://petstore.swagger.io/v2http://notificationServer.com?url={$request.body#/callbackUrl}&event={$request.body#/eventName}

Body

Callbacks Responses​

Responses

Callbacks Responses

Callbacks Responses

Callbacks Responses

Callbacks Responses