Swagger Petstore (1.0.0)
Download OpenAPI specification:Download
Find out how to create Github repo for your OpenAPI spec.
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.
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
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.
+Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. +And that allows cross-domain communication from the browser. +All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
+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 |
|---|---|
| implicit OAuth Flow | Authorization URL: http://petstore.swagger.io/api/oauth/dialog Scopes:
|
Add a new pet to the store
Add new pet to the store inventory.
+Authorizations: |
cookie Parameters
| cookieParam required | integer <int64> Some cookie + |
Request Body schema: application/json
| category | object (Category) Categories this pet belongs to + |
| name required | string The name given to a pet + |
| photoUrls required | Array of string The list of URL to a cute photos featuring pet + |
| friend | object (Pet) Recursive |
| tags | Array of object 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
Invalid input
+Request samples
- Payload
- C#
- PHP
- cat
- dog
- bee
- "category": {
- "name": "string",
- "sub": {
- "prop1": "string"
- "name": "Guru",
- "photoUrls": [
- "string"
- "friend": { },
- "tags": [
- {
- "name": "string"
- "status": "available",
- "petType": "string",
- "huntingSkill": "lazy"
Update an existing pet
Authorizations: |
cookie Parameters
| cookieParam required | integer <int64> Some cookie + |
Request Body schema: application/json
| category | object (Category) Categories this pet belongs to + |
| name required | string The name given to a pet + |
| photoUrls required | Array of string The list of URL to a cute photos featuring pet + |
| friend | object (Pet) Recursive |
| tags | Array of object 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
Invalid ID supplied
+Pet not found
+Validation exception
+Request samples
- Payload
- PHP
- cat
- dog
- bee
- "category": {
- "name": "string",
- "sub": {
- "prop1": "string"
- "name": "Guru",
- "photoUrls": [
- "string"
- "friend": { },
- "tags": [
- {
- "name": "string"
- "status": "available",
- "petType": "string",
- "huntingSkill": "lazy"
Find pet by ID
Returns a single pet
+Authorizations: |
path Parameters
| petId required | integer <int64> Deprecated ID of pet to return + |
Responses
successful operation
+Invalid ID supplied
+Pet not found
+Response samples
- 200
- cat
- dog
- bee
- "id": 0,
- "category": {
- "id": 0,
- "name": "string",
- "sub": {
- "prop1": "string"
- "name": "Guru",
- "photoUrls": [
- "string"
- "friend": { },
- "tags": [
- {
- "id": 0,
- "name": "string"
- "status": "available",
- "petType": "string",
- "huntingSkill": "lazy"
Updates a pet in the store with form data
Authorizations: |
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
Invalid input
+Deletes a pet
Authorizations: |
path Parameters
| petId required | integer <int64> Pet id to delete + |
header Parameters
| api_key | string Example: "Bearer <TOKEN>" |
Responses
Invalid pet value
+uploads an image
Authorizations: |
path Parameters
| petId required | integer <int64> ID of pet to update + |
Request Body schema: application/octet-stream
Responses
successful operation
+Response samples
- 200
- "code": 0,
- "type": "string",
- "message": "string"
Finds Pets by status
Multiple status values can be provided with comma seperated strings
+Authorizations: |
query Parameters
| status required | Array of string Items Enum:"available" "pending" "sold" Status values that need to be considered for filter + |
Responses
successful operation
+Invalid status value
+Response samples
- 200
- {
- "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
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+Authorizations: |
query Parameters
| tags required | Array of string Tags to filter by + |
Responses
successful operation
+Invalid tag value
+Response samples
- 200
- {
- "id": 0,
- "category": {
- "id": 0,
- "name": "string",
- "sub": {
- "prop1": "string"
- "name": "Guru",
- "photoUrls": [
- "string"
- "friend": { },
- "tags": [
- {
- "id": 0,
- "name": "string"
- "status": "available",
- "petType": "string"
Returns pet inventories by status
Returns a map of status codes to quantities
+Authorizations: |
Responses
successful operation
+Response samples
- 200
- "property1": 0,
- "property2": 0
Place an order for a pet
Request Body schema: application/json
| quantity | integer <int32> >= 1 Default: 1 |
| shipDate | string <date-time> Estimated ship date + |
| status | string Enum:"placed" "approved" "delivered" Order Status + |
| complete | boolean Indicates whenever order was completed or not + |
Responses
successful operation
+Invalid Order
+Request samples
- Payload
- "quantity": 1,
- "shipDate": "2018-03-18T08:51:17Z",
- "status": "placed",
- "complete": false
Response samples
- 200
- 400
- "id": 0,
- "petId": 0,
- "quantity": 1,
- "shipDate": "2018-03-18T08:51:17Z",
- "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
successful operation
+Invalid ID supplied
+Order not found
+Response samples
- 200
- "id": 0,
- "petId": 0,
- "quantity": 1,
- "shipDate": "2018-03-18T08:51:17Z",
- "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
Invalid ID supplied
+Order not found
+Create user
This can only be done by the logged in user.
+Request Body schema: application/json
| pet | object or object |
| username | string >= 4 characters User supplied username + |
| firstName | string non-empty User first name + |
| lastName | string non-empty User last name + |
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 Nullable ^\+(?:[0-9]-?){6,14}[0-9]$ User phone number in international format + |
| userStatus | integer <int32> User status + |
Responses
successful operation
+Request samples
- Payload
- "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
successful operation
+Invalid username supplied
+User not found
+Response samples
- 200
- "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
| pet | object or object |
| username | string >= 4 characters User supplied username + |
| firstName | string non-empty User first name + |
| lastName | string non-empty User last name + |
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 Nullable ^\+(?:[0-9]-?){6,14}[0-9]$ User phone number in international format + |
| userStatus | integer <int32> User status + |
Responses
Invalid user supplied
+User not found
+Request samples
- Payload
- "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
Invalid username supplied
+User not found
+Creates list of users with given input array
Request Body schema: application/json
| pet | object or object |
| username | string >= 4 characters User supplied username + |
| firstName | string non-empty User first name + |
| lastName | string non-empty User last name + |
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 Nullable ^\+(?:[0-9]-?){6,14}[0-9]$ User phone number in international format + |
| userStatus | integer <int32> User status + |
Responses
successful operation
+Request samples
- Payload
- {
- "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
| pet | object or object |
| username | string >= 4 characters User supplied username + |
| firstName | string non-empty User first name + |
| lastName | string non-empty User last name + |
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 Nullable ^\+(?:[0-9]-?){6,14}[0-9]$ User phone number in international format + |
| userStatus | integer <int32> User status + |
Responses
successful operation
+Request samples
- Payload
- {
- "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
successful operation
+Invalid username/password supplied
+Response samples
- 200