Swagger Petstore

v1.0.0

Information

image info

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 OpenAPI Documentation Generator tool.
In addition to OpenAPI Documentation Generator Tool, you can easily test your API using OpenAPI Tester tool.

OpenAPI Specification

A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.

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.

Legal

Contact

Send mail to
Website

Servers

Server Variables

Computed URL

Paths

pet

Tag description

post

/pet

Responses

200

Result

application/json

Type

object

One of

Choices

schema : Schema (0)

schema : Schema (1)

Source


{
  "oneOf": [
    {"description": "Success"},
    {"description": "Hello"}
  ]
}

Annotations

Description  Success

Type

empty schema

Source


{"description": "Success"}

Annotations

Description  Hello

Type

empty schema

Source


{"description": "Hello"}

405

Invalid input

RequestBody

Security

0{"petstore_auth":["write:pets","read:pets"]}

put

/pet

get

/pet/findByStatus

Parameters

required

status

Status values that need to be considered for filter

[ query ]

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {
    "default": "available",
    "type": "string",
    "enum": [
      "sold",
      "pending",
      "available"
    ]
  }
}

Type

string

Constraints

Default : available

Enumeration

Values

sold

pending

available

Source


 "items": {
  "default": "available",
  "type": "string",
  "enum": [
    "sold",
    "pending",
    "available"
  ]
}

Responses

200

successful operation

application/xml

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Pet"}
}

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Pet"}

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Pet"}
}

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Pet"}

400

Invalid status value

Security

0{"petstore_auth":["write:pets","read:pets"]}

post

/pet/{petId}/uploadImage

Parameters

required

petId

ID of pet to update

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{"type": "integer"}

Type

number

Source


{"type": "integer"}

Type

string

Source

{}

Responses

200

successful operation

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ApiResponse"}

RequestBody

application/octet-stream

Type

string

Source


{"type": "string"}

Security

0{"petstore_auth":["write:pets","read:pets"]}

get

/pet/findByTags

Parameters

required

tags

Tags to filter by

[ query ]

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"type": "string"}
}

Type

string

Source


 "items": {"type": "string"}

Responses

200

successful operation

application/xml

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Pet"}
}

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Pet"}

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Pet"}
}

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Pet"}

400

Invalid tag value

Security

0{"petstore_auth":["write:pets","read:pets"]}

post

/pet/{petId}

Parameters

required

petId

ID of pet that needs to be updated

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{"type": "integer"}

Type

number

Source


{"type": "integer"}

Type

string

Source

{}

Responses

405

Invalid input

RequestBody

application/x-www-form-urlencoded

Type

object

Properties

Name	Occurrence
name status	optional optional

Source


{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Updated name of the pet"
    },
    "status": {
      "type": "string",
      "description": "Updated status of the pet"
    }
  }
}

Annotations

Description  Updated name of the pet

Type

string

Source


 "name": {
  "type": "string",
  "description": "Updated name of the pet"
}

Annotations

Description  Updated status of the pet

Type

string

Source


 "status": {
  "type": "string",
  "description": "Updated status of the pet"
}

Security

0{"petstore_auth":["write:pets","read:pets"]}

get

/pet/{petId}

Parameters

required

petId

ID of pet to return

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{"type": "integer"}

Type

number

Source


{"type": "integer"}

Type

string

Source

{}

Responses

200

successful operation

application/xml

Type

empty schema

Source


{"ref": "#/components/schemas/Pet"}

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Pet"}

400

Invalid ID supplied

404

Pet not found

Security

0{"api_key":[]}

delete

/pet/{petId}

Parameters

required

petId

Pet id to delete

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{"type": "integer"}

Type

number

Source


{"type": "integer"}

Type

string

Source

{}

optional

api_key

[ header ]

Type

string

Source


{"type": "string"}

Responses

400

Invalid ID supplied

404

Pet not found

Security

0{"petstore_auth":["write:pets","read:pets"]}

store

Tag description

get

/store/inventory

Responses

200

successful operation

application/json

Type

object

Additional Properties

#/additionalProperties

Source


{
  "type": "object",
  "additionalProperties": {"type": "integer"}
}

Type

object

All of

Choices

additionalProperties : Schema (#/additionalProperties/0)

additionalProperties : Schema (#/additionalProperties/1)

Source


 "additionalProperties": {"type": "integer"}

Type

number

Source


 "#/additionalProperties/0": {"type": "integer"}

Type

string

Source


 "#/additionalProperties/1": {}

Security

0{"api_key":[]}

post

/store/order

Responses

200

successful operation

application/xml

Type

empty schema

Source


{"ref": "#/components/schemas/Order"}

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Order"}

400

Invalid Order

RequestBody

order placed for purchasing the pet

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Order"}

get

/store/order/{orderId}

Parameters

required

orderId

ID of pet that needs to be fetched

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{
  "type": "integer",
  "minimum": 1,
  "maximum": 10
}

Type

number

Constraints

Minimum : 1

Maximum : 10

Source


{
  "type": "integer",
  "minimum": 1,
  "maximum": 10
}

Type

string

Source

{}

Responses

200

successful operation

application/xml

Type

empty schema

Source


{"ref": "#/components/schemas/Order"}

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Order"}

400

Invalid ID supplied

404

Order not found

delete

/store/order/{orderId}

Parameters

required

orderId

ID of the order that needs to be deleted

[ path ]

Type

object

All of

Choices

schema : Schema (#/schema/0)

schema : Schema (#/schema/1)

Source


{
  "type": "integer",
  "minimum": 1
}

Type

number

Constraints

Minimum : 1

Source


{
  "type": "integer",
  "minimum": 1
}

Type

string

Source

{}

Responses

400

Invalid ID supplied

404

Order not found

user

Tag description

get

/user/{username}

Parameters

required

username

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

[ path ]

Type

string

Source


{"type": "string"}

Responses

200

successful operation

application/xml

Type

empty schema

Source


{"ref": "#/components/schemas/User"}

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/User"}

400

Invalid username supplied

404

User not found

delete

/user/{username}

Parameters

required

username

The name that needs to be deleted

[ path ]

Type

string

Source


{"type": "string"}

Responses

400

Invalid username supplied

404

User not found

put

/user/{username}

Parameters

required

username

name that need to be updated

[ path ]

Type

string

Source


{"type": "string"}

Responses

400

Invalid user supplied

404

User not found

RequestBody

Updated user object

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/User"}

post

/user/createWithList

get

/user/login

Parameters

required

password

The password for login in clear text

[ query ]

Type

string

Source


{"type": "string"}

required

username

The user name for login

[ query ]

Type

string

Source


{"type": "string"}

Responses

200

successful operation

application/xml

Type

string

Source


{"type": "string"}

application/json

Type

string

Source


{"type": "string"}

400

Invalid username/password supplied

post

/user

Responses

default

successful operation

RequestBody

Created user object

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/User"}

post

/user/createWithArray

get

/user/logout

Components

Order

Diagram

Type

object

Properties

Name	Occurrence
id petId quantity shipDate status complete	optional optional optional optional optional optional

Source


 "Order": {
  "type": "object",
  "xml": {"name": "Order"},
  "properties": {
    "id": {"type": "integer"},
    "petId": {"type": "integer"},
    "quantity": {"type": "integer"},
    "shipDate": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Order Status",
      "type": "string",
      "enum": [
        "approved",
        "placed",
        "delivered"
      ]
    },
    "complete": {
      "default": false,
      "type": "boolean"
    }
  }
}

Diagram

Type

object

All of

Choices

id : Schema (#/properties/Order/properties/id/0)

id : Schema (#/properties/Order/properties/id/1)

Source


 "id": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Order/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Order/properties/id/1": {}

Diagram

Type

object

All of

Choices

petId : Schema (#/properties/Order/properties/id/0)

petId : Schema (#/properties/Order/properties/id/1)

Source


 "petId": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Order/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Order/properties/id/1": {}

Diagram

Type

object

All of

Choices

quantity : Schema (#/properties/Order/properties/id/0)

quantity : Schema (#/properties/Order/properties/id/1)

Source


 "quantity": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Order/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Order/properties/id/1": {}

Diagram

Type

string

Constraints

Format : date-time

Source


 "shipDate": {
  "type": "string",
  "format": "date-time"
}

Annotations

Description  Order Status

Diagram

Type

string

Enumeration

Values

approved

placed

delivered

Source


 "status": {
  "description": "Order Status",
  "type": "string",
  "enum": [
    "approved",
    "placed",
    "delivered"
  ]
}

Diagram

Type

boolean

Default value :

false

Source


 "complete": {
  "default": false,
  "type": "boolean"
}

Category

Diagram

Type

object

Properties

Name	Occurrence
id name	optional optional

Source


 "Category": {
  "type": "object",
  "xml": {"name": "Category"},
  "properties": {
    "id": {"type": "integer"},
    "name": {"type": "string"}
  }
}

Diagram

Type

object

All of

Choices

id : Schema (#/properties/Category/properties/id/0)

id : Schema (#/properties/Category/properties/id/1)

Source


 "id": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Category/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Category/properties/id/1": {}

Diagram

Type

string

Source


 "name": {"type": "string"}

User

Diagram

Type

object

Properties

Name	Occurrence
id username firstName lastName email password phone userStatus	optional optional optional optional optional optional optional optional

Source


 "User": {
  "type": "object",
  "xml": {"name": "User"},
  "properties": {
    "id": {"type": "integer"},
    "username": {"type": "string"},
    "firstName": {"type": "string"},
    "lastName": {"type": "string"},
    "email": {"type": "string"},
    "password": {"type": "string"},
    "phone": {"type": "string"},
    "userStatus": {
      "description": "User Status",
      "type": "integer"
    }
  }
}

Diagram

Type

object

All of

Choices

id : Schema (#/properties/User/properties/id/0)

id : Schema (#/properties/User/properties/id/1)

Source


 "id": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/User/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/User/properties/id/1": {}

Diagram

Type

string

Source


 "username": {"type": "string"}

Diagram

Type

string

Source


 "firstName": {"type": "string"}

Diagram

Type

string

Source


 "lastName": {"type": "string"}

Diagram

Type

string

Source


 "email": {"type": "string"}

Diagram

Type

string

Source


 "password": {"type": "string"}

Diagram

Type

string

Source


 "phone": {"type": "string"}

Annotations

Description  User Status

Diagram

Type

object

All of

Choices

userStatus : Schema (#/properties/User/properties/id/0)

userStatus : Schema (#/properties/User/properties/id/1)

Source


 "userStatus": {
  "description": "User Status",
  "type": "integer"
}

Diagram

Type

number

Source


 "#/properties/User/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/User/properties/id/1": {}

Tag

Diagram

Type

object

Properties

Name	Occurrence
id name	optional optional

Source


 "Tag": {
  "type": "object",
  "xml": {"name": "Tag"},
  "properties": {
    "id": {"type": "integer"},
    "name": {"type": "string"}
  }
}

Diagram

Type

object

All of

Choices

id : Schema (#/properties/Tag/properties/id/0)

id : Schema (#/properties/Tag/properties/id/1)

Source


 "id": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Tag/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Tag/properties/id/1": {}

Diagram

Type

string

Source


 "name": {"type": "string"}

Pet

Diagram

Type

object

Properties

Name	Occurrence
id category name photoUrls tags status	optional optional required required optional optional

Source


 "Pet": {
  "type": "object",
  "xml": {"name": "Pet"},
  "required": [
    "name",
    "photoUrls"
  ],
  "properties": {
    "id": {"type": "integer"},
    "category": {"ref": "#/components/schemas/Category"},
    "name": {
      "type": "string",
      "example": "doggie"
    },
    "photoUrls": {
      "type": "array",
      "xml": {
        "name": "photoUrl",
        "wrapped": true
      },
      "items": {}
    },
    "tags": {
      "type": "array",
      "xml": {
        "name": "tag",
        "wrapped": true
      },
      "items": {}
    },
    "status": {
      "description": "pet status in the store",
      "type": "string",
      "enum": [
        "sold",
        "pending",
        "available"
      ]
    }
  }
}

Diagram

Type

object

All of

Choices

id : Schema (#/properties/Pet/properties/id/0)

id : Schema (#/properties/Pet/properties/id/1)

Source


 "id": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/Pet/properties/id/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/Pet/properties/id/1": {}

Diagram

Type

empty schema

Source


 "category": {"ref": "#/components/schemas/Category"}

Diagram

Type

string

Source


 "name": {
  "type": "string",
  "example": "doggie"
}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/Pet/properties/photoUrls/items

Source


 "photoUrls": {
  "type": "array",
  "xml": {
    "name": "photoUrl",
    "wrapped": true
  },
  "items": {"type": "string"}
}

Diagram

Type

string

Source


 "items": {"type": "string"}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/Pet/properties/tags/items

Source


 "tags": {
  "type": "array",
  "xml": {
    "name": "tag",
    "wrapped": true
  },
  "items": {"ref": "#/components/schemas/Tag"}
}

Diagram

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Tag"}

Annotations

Description  pet status in the store

Diagram

Type

string

Enumeration

Values

sold

pending

available

Source


 "status": {
  "description": "pet status in the store",
  "type": "string",
  "enum": [
    "sold",
    "pending",
    "available"
  ]
}

ApiResponse

Diagram

Type

object

Properties

Name	Occurrence
code type message	optional optional optional

Source


 "ApiResponse": {
  "type": "object",
  "properties": {
    "code": {"type": "integer"},
    "type": {"type": "string"},
    "message": {"type": "string"}
  }
}

Diagram

Type

object

All of

Choices

code : Schema (#/properties/ApiResponse/properties/code/0)

code : Schema (#/properties/ApiResponse/properties/code/1)

Source


 "code": {"type": "integer"}

Diagram

Type

number

Source


 "#/properties/ApiResponse/properties/code/0": {"type": "integer"}

Diagram

Type

string

Source


 "#/properties/ApiResponse/properties/code/1": {}

Diagram

Type

string

Source


 "type": {"type": "string"}

Diagram

Type

string

Source


 "message": {"type": "string"}

RequestBody

UserArray

List of user object

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/User"}
}

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/User"}

Pet

Pet object that needs to be added to the store

application/xml

Type

empty schema

Source


{"ref": "#/components/schemas/Pet"}

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Pet"}

SecuritySchemes

petstore_auth

api_key