Redoc

You can display the whole OpenAPI documentation using a React component

File format

You cannot import a React component inside a .md file.
Change your file extension to .mdx before importing the React Component.
Read more here about MDX in Docusaurus.

Import

import Redoc from '@theme/Redoc';

Props

Name	Type	Description
id	String	When spec not provided, load the spec from docusaurus config. Use first spec if not defined
spec	OpenAPI spec	A JSON content spec to use
url	String	External URL to load spec file from
themeId	String	redocusaurus theme to use - default to `theme-redoc`
downloadSpecUrl	String	Public path to the spec file used, used by Redoc as download url

Examples

Basic example

It displays here the first element of the redocusaurus configuration.

import Redoc from '@theme/Redoc';

<Redoc />

API docs by Redocly

Swagger Petstore (1.0.0)

Download OpenAPI specification:Download

API Support: apiteam@swagger.io URL: https://github.com/Redocly/redoc License: Apache 2.0 Terms of Service

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Find out how to create Github repo for your OpenAPI spec.

Introduction

This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team. It was extended to illustrate features of generator-openapi-repo tool and ReDoc documentation. In addition to standard OpenAPI syntax we use a few vendor extensions.

OpenAPI Specification

Authentication

Petstore offers two forms of authentication:

API Key
OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

petstore_auth

Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.

Security Scheme Type: OAuth2

Flow type: implicit

Authorization URL: http://petstore.swagger.io/api/oauth/dialog

Scopes:

write:pets -
modify pets in your account
read:pets -
read your pets

api_key

For this sample, you can use the api key special-key to test the authorization filters.

Security Scheme Type: API Key

Header parameter name: api_key

pet

Everything about your Pets

New pet Webhook

Information about a new pet in the systems

Request Body schema: application/json

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Update an existing pet

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Find pet by ID

Returns a single pet

Authorizations:

api_key

path Parameters

petId

required

integer <int64>

Deprecated

ID of pet to return

Responses

Response samples

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Updates a pet in the store with form data

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet that needs to be updated

Request Body schema: application/x-www-form-urlencoded

name	string Updated name of the pet
status	string Updated status of the pet

Responses

Deletes a pet

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

Pet id to delete

header Parameters

api_key

string

Example: Bearer <TOKEN>

Responses

uploads an image

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet to update

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

Content type

application/json

{"code": 0,
"type": "string",
"message": "string"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Authorizations:

petstore_auth

query Parameters

status

required

Array of strings [ 1 .. 3 ] items

Items Enum: "available" "pending" "sold"

Status values that need to be considered for filter

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

Finds Pets by tags Deprecated

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations:

petstore_auth

query Parameters

tags

required

Array of strings

Tags to filter by

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

store

Access to Petstore orders

Returns pet inventories by status

Returns a map of status codes to quantities

Authorizations:

api_key

Responses

Response samples

Content type

application/json

{"property1": 0,
"property2": 0
}

Place an order for a pet

Request Body schema: application/json
required

order placed for purchasing the pet

quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
requestId	string Unique Request Id

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"requestId": "string"
}

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Find purchase order by ID

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

path Parameters

orderId

required

integer <int64> [ 1 .. 5 ]

ID of pet that needs to be fetched

Responses

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

path Parameters

orderId

required

string >= 1

ID of the order that needs to be deleted

Responses

Subscribe to the Store events

Add subscription for a store events

Request Body schema: application/json

callbackUrl required	string <uri> This URL will be called by the server when the desired event will occur
eventName required	string Enum: "orderInProgress" "orderShipped" "orderDelivered" Event name for the subscription

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"callbackUrl": "https://myserver.com/send/callback/here",
"eventName": "orderInProgress"
}

Response samples

Content type

application/json

{"subscriptionId": "AAA-123-BBB-456"
}

Callback payload samples

Callback

POST: Order in Progress (Summary)

Content type

application/json

{"orderId": "123",
"timestamp": "2018-10-19T16:46:45Z",
"status": "inProgress"
}

user

Operations about user

Create user

This can only be done by the logged in user.

Request Body schema: application/json
required

Created user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Get user by user name

path Parameters

username

required

string

The name that needs to be fetched. Use user1 for testing.

Responses

Response samples

Content type

application/json

{"id": 0,
"pet": {"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Updated user

This can only be done by the logged in user.

path Parameters

username

required

string

name that need to be deleted

Request Body schema: application/json
required

Updated user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Delete user

This can only be done by the logged in user.

path Parameters

username

required

string

The name that needs to be deleted

Responses

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}
]

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}
]

Logs user into the system

query Parameters

username required	string The user name for login
password required	string The password for login in clear text

Responses

Response samples

Content type

application/json

"OK"

Logs out current logged in user session

Responses

The Pet Model

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

The Order Model

id	integer <int64> Order ID
petId	integer <int64> Pet ID
quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
complete	boolean Default: false Indicates whenever order was completed or not
requestId	string Unique Request Id

{"quantity": 1,
"shipDate": "2018-10-19T16:46:45Z",
"status": "placed",
"complete": false
}

External URL example

import Redoc from '@theme/Redoc';

<Redoc url="https://redocly.github.io/redoc/openapi.yaml"/>

Loading ...

Specific id example

import Redoc from '@theme/Redoc';

<Redoc id="using-single-yaml" />

API docs by Redocly

Swagger Petstore [Automatic Page From File] (1.0.0)

Download OpenAPI specification:Download

API Support: apiteam@swagger.io URL: https://github.com/Redocly/redoc License: Apache 2.0 Terms of Service

Find out how to create Github repo for your OpenAPI spec.

Introduction

OpenAPI Specification

Authentication

Petstore offers two forms of authentication:

API Key
OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

petstore_auth

Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.

Security Scheme Type: OAuth2

Flow type: implicit

Authorization URL: http://petstore.swagger.io/api/oauth/dialog

Scopes:

write:pets -
modify pets in your account
read:pets -
read your pets

api_key

For this sample, you can use the api key special-key to test the authorization filters.

Security Scheme Type: API Key

Header parameter name: api_key

pet

Everything about your Pets

New pet Webhook

Information about a new pet in the systems

Request Body schema: application/json

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Update an existing pet

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Find pet by ID

Returns a single pet

Authorizations:

api_key

path Parameters

petId

required

integer <int64>

Deprecated

ID of pet to return

Responses

Response samples

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Updates a pet in the store with form data

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet that needs to be updated

Request Body schema: application/x-www-form-urlencoded

name	string Updated name of the pet
status	string Updated status of the pet

Responses

Deletes a pet

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

Pet id to delete

header Parameters

api_key

string

Example: Bearer <TOKEN>

Responses

uploads an image

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet to update

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

Content type

application/json

{"code": 0,
"type": "string",
"message": "string"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Authorizations:

petstore_auth

query Parameters

status

required

Array of strings [ 1 .. 3 ] items

Items Enum: "available" "pending" "sold"

Status values that need to be considered for filter

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

Finds Pets by tags Deprecated

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations:

petstore_auth

query Parameters

tags

required

Array of strings

Tags to filter by

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

store

Access to Petstore orders

Returns pet inventories by status

Returns a map of status codes to quantities

Authorizations:

api_key

Responses

Response samples

Content type

application/json

{"property1": 0,
"property2": 0
}

Place an order for a pet

Request Body schema: application/json
required

order placed for purchasing the pet

quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
requestId	string Unique Request Id

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"requestId": "string"
}

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Find purchase order by ID

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

path Parameters

orderId

required

integer <int64> [ 1 .. 5 ]

ID of pet that needs to be fetched

Responses

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

path Parameters

orderId

required

string >= 1

ID of the order that needs to be deleted

Responses

Subscribe to the Store events

Add subscription for a store events

Request Body schema: application/json

callbackUrl required	string <uri> This URL will be called by the server when the desired event will occur
eventName required	string Enum: "orderInProgress" "orderShipped" "orderDelivered" Event name for the subscription

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"callbackUrl": "https://myserver.com/send/callback/here",
"eventName": "orderInProgress"
}

Response samples

Content type

application/json

{"subscriptionId": "AAA-123-BBB-456"
}

Callback payload samples

Callback

POST: Order in Progress (Summary)

Content type

application/json

{"orderId": "123",
"timestamp": "2018-10-19T16:46:45Z",
"status": "inProgress"
}

user

Operations about user

Create user

This can only be done by the logged in user.

Request Body schema: application/json
required

Created user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Get user by user name

path Parameters

username

required

string

The name that needs to be fetched. Use user1 for testing.

Responses

Response samples

Content type

application/json

{"id": 0,
"pet": {"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Updated user

This can only be done by the logged in user.

path Parameters

username

required

string

name that need to be deleted

Request Body schema: application/json
required

Updated user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Delete user

This can only be done by the logged in user.

path Parameters

username

required

string

The name that needs to be deleted

Responses

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}
]

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}
]

Logs user into the system

query Parameters

username required	string The user name for login
password required	string The password for login in clear text

Responses

Response samples

Content type

application/json

"OK"

Logs out current logged in user session

Responses

The Pet Model

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

The Order Model

id	integer <int64> Order ID
petId	integer <int64> Pet ID
quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
complete	boolean Default: false Indicates whenever order was completed or not
requestId	string Unique Request Id

{"quantity": 1,
"shipDate": "2018-10-19T16:46:45Z",
"status": "placed",
"complete": false
}

Download url example

import Redoc from '@theme/Redoc';

<Redoc id="using-single-yaml" downloadSpecUrl="https://redocly.github.io/redoc/openapi.yaml" />

API docs by Redocly

Swagger Petstore [Automatic Page From File] (1.0.0)

Download OpenAPI specification:Download

API Support: apiteam@swagger.io URL: https://github.com/Redocly/redoc License: Apache 2.0 Terms of Service

Find out how to create Github repo for your OpenAPI spec.

Introduction

OpenAPI Specification

Authentication

Petstore offers two forms of authentication:

API Key
OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

petstore_auth

Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.

Security Scheme Type: OAuth2

Flow type: implicit

Authorization URL: http://petstore.swagger.io/api/oauth/dialog

Scopes:

write:pets -
modify pets in your account
read:pets -
read your pets

api_key

For this sample, you can use the api key special-key to test the authorization filters.

Security Scheme Type: API Key

Header parameter name: api_key

pet

Everything about your Pets

New pet Webhook

Information about a new pet in the systems

Request Body schema: application/json

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Update an existing pet

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Find pet by ID

Returns a single pet

Authorizations:

api_key

path Parameters

petId

required

integer <int64>

Deprecated

ID of pet to return

Responses

Response samples

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Updates a pet in the store with form data

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet that needs to be updated

Request Body schema: application/x-www-form-urlencoded

name	string Updated name of the pet
status	string Updated status of the pet

Responses

Deletes a pet

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

Pet id to delete

header Parameters

api_key

string

Example: Bearer <TOKEN>

Responses

uploads an image

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet to update

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

Content type

application/json

{"code": 0,
"type": "string",
"message": "string"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Authorizations:

petstore_auth

query Parameters

status

required

Array of strings [ 1 .. 3 ] items

Items Enum: "available" "pending" "sold"

Status values that need to be considered for filter

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

Finds Pets by tags Deprecated

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations:

petstore_auth

query Parameters

tags

required

Array of strings

Tags to filter by

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

store

Access to Petstore orders

Returns pet inventories by status

Returns a map of status codes to quantities

Authorizations:

api_key

Responses

Response samples

Content type

application/json

{"property1": 0,
"property2": 0
}

Place an order for a pet

Request Body schema: application/json
required

order placed for purchasing the pet

quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
requestId	string Unique Request Id

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"requestId": "string"
}

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Find purchase order by ID

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

path Parameters

orderId

required

integer <int64> [ 1 .. 5 ]

ID of pet that needs to be fetched

Responses

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

path Parameters

orderId

required

string >= 1

ID of the order that needs to be deleted

Responses

Subscribe to the Store events

Add subscription for a store events

Request Body schema: application/json

callbackUrl required	string <uri> This URL will be called by the server when the desired event will occur
eventName required	string Enum: "orderInProgress" "orderShipped" "orderDelivered" Event name for the subscription

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"callbackUrl": "https://myserver.com/send/callback/here",
"eventName": "orderInProgress"
}

Response samples

Content type

application/json

{"subscriptionId": "AAA-123-BBB-456"
}

Callback payload samples

Callback

POST: Order in Progress (Summary)

Content type

application/json

{"orderId": "123",
"timestamp": "2018-10-19T16:46:45Z",
"status": "inProgress"
}

user

Operations about user

Create user

This can only be done by the logged in user.

Request Body schema: application/json
required

Created user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Get user by user name

path Parameters

username

required

string

The name that needs to be fetched. Use user1 for testing.

Responses

Response samples

Content type

application/json

{"id": 0,
"pet": {"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Updated user

This can only be done by the logged in user.

path Parameters

username

required

string

name that need to be deleted

Request Body schema: application/json
required

Updated user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}

Delete user

This can only be done by the logged in user.

path Parameters

username

required

string

The name that needs to be deleted

Responses

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}
]

Creates list of users with given input array

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0
}
]

Logs user into the system

query Parameters

username required	string The user name for login
password required	string The password for login in clear text

Responses

Response samples

Content type

application/json

"OK"

Logs out current logged in user session

Responses

The Pet Model

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

The Order Model

id	integer <int64> Order ID
petId	integer <int64> Pet ID
quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
complete	boolean Default: false Indicates whenever order was completed or not
requestId	string Unique Request Id

{"quantity": 1,
"shipDate": "2018-10-19T16:46:45Z",
"status": "placed",
"complete": false
}

Webpack loader example

You can provide a JSON spec to the component like this. Webpack will load the file directly, you don't need to use redocusaurus configuration inside docusaurus.config.js.

import Redoc from '@theme/Redoc';
import openApi from './api-with-examples.json'

<Redoc spec={openApi} />

API docs by Redocly

Swagger Petstore (1.0.0)

Download OpenAPI specification:Download

API Support: apiteam@swagger.io URL: https://github.com/Redocly/redoc License: Apache 2.0 Terms of Service

Find out how to create Github repo for your OpenAPI spec.

Introduction

OpenAPI Specification

Authentication

Petstore offers two forms of authentication:

API Key
OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

petstore_auth

Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.

Security Scheme Type: OAuth2

Flow type: implicit

Authorization URL: http://petstore.swagger.io/api/oauth/dialog

Scopes:

write:pets -
modify pets in your account
read:pets -
read your pets

api_key

For this sample, you can use the api key special-key to test the authorization filters.

Security Scheme Type: API Key

Header parameter name: api_key

pet

Everything about your Pets

Cat

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] Default: [] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

New pet Webhook

Information about a new pet in the systems

Authorizations:

None

Request Body schema: application/json

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] Default: [] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] Default: [] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Update an existing pet

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] Default: [] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Find pet by ID

Returns a single pet

Authorizations:

api_key

path Parameters

petId

required

integer <int64>

Deprecated

ID of pet to return

Responses

Response samples

Content type

application/json

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Updates a pet in the store with form data

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet that needs to be updated

Request Body schema: application/x-www-form-urlencoded

name	string Updated name of the pet
status	string Updated status of the pet

Responses

Deletes a pet

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

Pet id to delete

header Parameters

api_key

string

Example: Bearer <TOKEN>

Responses

uploads an image

Authorizations:

petstore_auth

path Parameters

petId

required

integer <int64>

ID of pet to update

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

Content type

application/json

{"code": 0,
"type": "string",
"message": "string"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Authorizations:

petstore_auth

query Parameters

status

required

Array of strings [ 1 .. 3 ] items

Items Enum: "available" "pending" "sold"

Status values that need to be considered for filter

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

Finds Pets by tags Deprecated

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations:

petstore_auth

query Parameters

tags

required

Array of strings

Tags to filter by

Responses

Response samples

Content type

application/json

[{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
}
]

store

Access to Petstore orders

Returns pet inventories by status

Returns a map of status codes to quantities

Authorizations:

api_key

Responses

Response samples

Content type

application/json

{"property1": 0,
"property2": 0
}

Place an order for a pet

Authorizations:

None

Request Body schema: application/json
required

order placed for purchasing the pet

quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
requestId	string Unique Request Id

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"requestId": "string"
}

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Find purchase order by ID

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

Authorizations:

None

path Parameters

orderId

required

integer <int64> [ 1 .. 5 ]

ID of pet that needs to be fetched

Responses

Response samples

Content type

application/json

{"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "2019-08-24T14:15:22Z",
"status": "placed",
"complete": false
}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Authorizations:

None

path Parameters

orderId

required

string >= 1

ID of the order that needs to be deleted

Responses

Subscribe to the Store events

Add subscription for a store events

Authorizations:

None

Request Body schema: application/json

callbackUrl required	string <uri> This URL will be called by the server when the desired event will occur
eventName required	string Enum: "orderInProgress" "orderShipped" "orderDelivered" Event name for the subscription

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"callbackUrl": "https://myserver.com/send/callback/here",
"eventName": "orderInProgress"
}

Response samples

Content type

application/json

{"subscriptionId": "AAA-123-BBB-456"
}

Callback payload samples

Callback

POST: Order in Progress (Summary)

Content type

application/json

{"orderId": "123",
"timestamp": "2018-10-19T16:46:45Z",
"status": "inProgress"
}

user

Operations about user

Create user

This can only be done by the logged in user.

Authorizations:

None

Request Body schema: application/json
required

Created user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Get user by user name

Authorizations:

None

path Parameters

username

required

string

The name that needs to be fetched. Use user1 for testing.

Responses

Response samples

Content type

application/json

{"id": 0,
"pet": {"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Updated user

This can only be done by the logged in user.

Authorizations:

None

path Parameters

username

required

string

name that need to be deleted

Request Body schema: application/json
required

Updated user object

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}

Delete user

This can only be done by the logged in user.

Authorizations:

None

path Parameters

username

required

string

The name that needs to be deleted

Responses

Creates list of users with given input array

Authorizations:

None

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}
]

Creates list of users with given input array

Authorizations:

None

Request Body schema: application/json
required

List of user object

Array

	Pet (object) or Tag (object)
username	string >= 4 characters User supplied username
firstName	string non-empty User first name
lastName	string non-empty User last name
email	string <email> User email address
password	string <password> >= 8 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format
userStatus	integer <int32> User status
	Array of items <= 10 characters >= 0 items

Responses

Request samples

Payload

Content type

application/json

[{"pet": {"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "string"
},
"username": "John78",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"password": "drowssaP123",
"phone": "+1-202-555-0192",
"userStatus": 0,
"addresses": [{"city": "string",
"country": "string",
"street": "string"
},
0
]
}
]

Logs user into the system

Authorizations:

None

query Parameters

username required	string The user name for login
password required	string The password for login in clear text

Responses

Response samples

Content type

application/json

"OK"

Logs out current logged in user session

Authorizations:

None

Responses

The Pet Model

id	integer <int64> Pet ID Find more info here
	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] Default: [] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Example

cat

{"id": 0,
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [ ],
"friend": { },
"tags": [{"id": 0,
"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

The Order Model

id	integer <int64> Order ID
petId	integer <int64> Pet ID
quantity	integer <int32> >= 1 Default: 1
shipDate	string <date-time> Estimated ship date
status	string Enum: "placed" "approved" "delivered" Order Status
complete	boolean Default: false Indicates whenever order was completed or not
requestId	string Unique Request Id

{"quantity": 1,
"shipDate": "2018-10-19T16:46:45Z",
"status": "placed",
"complete": false
}

YAML support

You cannot load yaml file like this:

import openApi from './api-with-examples.yaml'

Without the right webpack configuration to handle such file format.

Redoc

Import​

Props​

Examples​

Basic example​

Swagger Petstore (1.0.0)

Introduction

OpenAPI Specification

Cross-Origin Resource Sharing

Authentication

petstore_auth

api_key

pet

New pet Webhook

Request Body schema: application/json

Responses

Request samples

Add a new pet to the store

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

Update an existing pet

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

Find pet by ID

Authorizations:

path Parameters

Responses

Response samples

Updates a pet in the store with form data

Authorizations:

path Parameters

Request Body schema: application/x-www-form-urlencoded

Responses

Deletes a pet

Authorizations:

path Parameters

header Parameters

Responses

uploads an image

Authorizations:

path Parameters

Request Body schema: application/octet-stream

Responses

Response samples

Finds Pets by status

Authorizations:

query Parameters

Responses

Response samples

Finds Pets by tags Deprecated

Authorizations:

query Parameters

Responses

Response samples

store

Returns pet inventories by status

Authorizations:

Responses

Response samples

Place an order for a pet

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Find purchase order by ID

path Parameters

Responses

Response samples

Delete purchase order by ID

path Parameters

Responses

Subscribe to the Store events

Import

Props

Examples

Basic example

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

External URL example

Specific id example

Request Body schema:
application/json
required

Request Body schema:
application/json
required