Documentation for paths

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

Used by

Schema

Source


{"description": "Success"}

Annotations

Description  Hello

Type

empty schema

Used by

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.html#/items

Source


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

Type

string

Constraints

Default : available

Enumeration

Values

sold

pending

available

Used by

Schema

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.html#/items

Source


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

Type

empty schema

Used by

Schema

Source


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

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


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

Type

empty schema

Used by

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

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

Source

{}

Type

number

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

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.html#/items

Source


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

Type

string

Used by

Schema

Source


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

Responses

200

successful operation

application/xml

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


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

Type

empty schema

Used by

Schema

Source


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

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


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

Type

empty schema

Used by

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

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

Source

{}

Type

number

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

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

Used by

Schema

name

Source


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

Annotations

Description  Updated status of the pet

Type

string

Used by

Schema

status

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

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

Source

{}

Type

number

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

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

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

Source

{}

Type

number

Used by

Schema

Source


{"type": "integer"}

Type

string

Used by

Schema

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.htmladditionalProperties.html#/additionalProperties

Source


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

Type

object

All of

Choices

additionalProperties : Schema (#/additionalProperties/0)

additionalProperties : Schema (#/additionalProperties/1)

Used by

Schema

Source


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

Type

number

Used by

Schema

#/additionalProperties

Source


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

Type

string

Used by

Schema

#/additionalProperties

Source


 "#/additionalProperties/1": {}

Type

number

Used by

Schema

#/additionalProperties

Source


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

Type

string

Used by

Schema

#/additionalProperties

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

Used by

Schema

Source


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

Type

string

Used by

Schema

Source

{}

Type

number

Constraints

Minimum : 1

Maximum : 10

Used by

Schema

Source


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

Type

string

Used by

Schema

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

Used by

Schema

Source


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

Type

string

Used by

Schema

Source

{}

Type

number

Constraints

Minimum : 1

Used by

Schema

Source


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

Type

string

Used by

Schema

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