Documentation for components

Diagram

Type

object

Properties

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

Used by

Schema

Order

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)

Used by

Schema

Order

Order/properties/id

Source


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

Diagram

Type

number

Used by

Schema

Order/properties/id

Order/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

Order/properties/id

Order/properties/id/1

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)

Used by

Schema

Order

Order/properties/petId

Source


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

Diagram

Type

number

Used by

Schema

Order/properties/petId

Order/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

Order/properties/petId

Order/properties/id/1

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)

Used by

Schema

Order

Order/properties/quantity

Source


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

Diagram

Type

number

Used by

Schema

Order/properties/quantity

Order/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

Order/properties/quantity

Order/properties/id/1

Source


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

Diagram

Type

string

Constraints

Format : date-time

Used by

Schema

Order

Order/properties/shipDate

Source


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

Annotations

Description  Order Status

Diagram

Type

string

Enumeration

Values

approved

placed

delivered

Used by

Schema

Order

Order/properties/status

Source


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

Diagram

Type

boolean

Default value :

false

Used by

Schema

Order

Order/properties/complete

Source


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

Diagram

Type

object

Properties

Name	Occurrence
id name	optional optional

Used by

Schema

Category

Category/properties/name

Source


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

Diagram

Type

object

Properties

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

Used by

Schema

User

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)

Used by

Schema

User

User/properties/id

Source


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

Diagram

Type

number

Used by

Schema

User/properties/id

User/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

User/properties/id

User/properties/id/1

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/username

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/firstName

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/lastName

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/email

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/password

Source


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

Diagram

Type

string

Used by

Schema

User

User/properties/phone

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)

Used by

Schema

User

User/properties/userStatus

Source


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

Diagram

Type

number

Used by

Schema

User/properties/userStatus

User/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

User/properties/userStatus

User/properties/id/1

Source


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

Diagram

Type

object

Properties

Name	Occurrence
id name	optional optional

Used by

Schema

Tag

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)

Used by

Schema

Tag

Tag/properties/id

Source


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

Diagram

Type

number

Used by

Schema

Tag/properties/id

Tag/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

Tag/properties/id

Tag/properties/id/1

Source


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

Diagram

Type

string

Used by

Schema

Tag

Tag/properties/name

Source


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

Diagram

Type

object

Properties

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

Used by

Schema

Pet

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)

Used by

Schema

Pet

Pet/properties/id

Source


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

Diagram

Type

number

Used by

Schema

Pet/properties/id

Pet/properties/id/0

Source


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

Diagram

Type

string

Used by

Schema

Pet/properties/id

Pet/properties/id/1

Source


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

Diagram

Type

empty schema

Used by

Schema

Pet

Pet/properties/category

Source


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

Diagram

Type

string

Used by

Schema

Pet

Pet/properties/name

Source


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

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

properties_Pet.html#/properties/Pet/properties/photoUrls/items

Used by

Schema

Pet

Pet/properties/photoUrls

Source


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

Diagram

Type

string

Used by

Schema

Pet/properties/photoUrls

Pet/properties/photoUrls/items

Source


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

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

properties_Pet.html#/properties/Pet/properties/tags/items

Used by

Schema

Pet

Pet/properties/tags

Source


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

Diagram

Type

empty schema

Used by

Schema

Pet/properties/tags

Pet/properties/tags/items

Source


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

Annotations

Description  pet status in the store

Diagram

Type

string

Enumeration

Values

sold

pending

available

Used by

Schema

Pet

Pet/properties/status

Source


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

Diagram

Type

object

Properties

Name	Occurrence
code type message	optional optional optional

Used by

Schema

ApiResponse

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)

Used by

Schema

ApiResponse

ApiResponse/properties/code

Source


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

Diagram

Type

number

Used by

Schema

ApiResponse/properties/code

ApiResponse/properties/code/0

Source


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

Diagram

Type

string

Used by

Schema

ApiResponse/properties/code

ApiResponse/properties/code/1

Source


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

Diagram

Type

string

Used by

Schema

ApiResponse

ApiResponse/properties/type

Source


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

Diagram

Type

string

Used by

Schema

ApiResponse

ApiResponse/properties/message

Source


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

RequestBody

UserArray

List of user object

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


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

Type

empty schema

Used by

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"}