Schemas

ApiResponse

  • object
    Example: {"code":0,"type":"string","message":"string"}
    Properties:
    • code
      integer:int32
      Example: 0
    • type
      string
      Example: "string"
    • message
      string
      Example: "string"

Cat

A representation of a cat
  • object
    Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available","huntingSkill":"clueless"}
    Properties:
    • id
      integer:int64
      Required
      Example: 0
    • category
      object
      Category
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      Example: "doggie"
    • photoUrls
      array<string>
      Required
      Example: ["string"]
      Items:
      • string
        Example: "string"
    • tags
      array
      Example: [{"id":0,"name":"string"}]
      Items:
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • status
      string
      pet status in the store
      Example: "available"
      Enum: available pending sold
    • huntingSkill
      string
      Required
      The measured skill for hunting
      Example: "clueless"
      Enum: clueless lazy adventurous aggressive

Category

  • object
    Example: {"id":0,"name":"string","sub":{"prop1":"string"}}
    Properties:
    • id
      integer:int64
      Id
      Category ID
      Example: 0
      ReadOnly
    • name
      string
      Category name
      Example: "string"
      Minimum string length: 1
    • sub
      object
      Test Sub Category
      Example: {"prop1":"string"}

Dog

A representation of a dog
  • object
    Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available","packSize":1}
    Properties:
    • id
      integer:int64
      Required
      Example: 0
    • category
      object
      Category
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      Example: "doggie"
    • photoUrls
      array<string>
      Required
      Example: ["string"]
      Items:
      • string
        Example: "string"
    • tags
      array
      Example: [{"id":0,"name":"string"}]
      Items:
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • status
      string
      pet status in the store
      Example: "available"
      Enum: available pending sold
    • packSize
      integer:int32
      Required
      The size of the pack the dog is from
      Example: 1
      >= 1

HoneyBee

A representation of a honey bee
  • object
    Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available","honeyPerDay":3.14}
    Properties:
    • id
      integer:int64
      Required
      Example: 0
    • category
      object
      Category
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      Example: "doggie"
    • photoUrls
      array<string>
      Required
      Example: ["string"]
      Items:
      • string
        Example: "string"
    • tags
      array
      Example: [{"id":0,"name":"string"}]
      Items:
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • status
      string
      pet status in the store
      Example: "available"
      Enum: available pending sold
    • honeyPerDay
      number
      Required
      Average amount of honey produced per day in ounces
      Example: 3.14

Id

  • integer:int64
    Example: 0
    ReadOnly

Order

  • object
    Example: {"id":0,"petId":0,"quantity":1,"shipDate":"2019-08-24T14:15:22Z","status":"placed","complete":false,"rqeuestId":"string"}
    Properties:
    • id
      integer:int64
      Id
      Order ID
      Example: 0
      ReadOnly
    • petId
      integer:int64
      Id
      Pet ID
      Example: 0
      ReadOnly
    • quantity
      integer:int32
      Example: 1
      >= 1
    • shipDate
      string:date-time
      Estimated ship date
      Example: "2019-08-24T14:15:22Z"
    • status
      string
      Order Status
      Example: "placed"
      Enum: placed approved delivered
    • complete
      boolean
      Indicates whenever order was completed or not
      Example: false
      ReadOnly
    • rqeuestId
      string
      Unique Request Id
      Example: "string"
      WriteOnly

Pet

  • object
    Example: {"id":0,"category":{"id":0,"name":"string"},"name":"Guru","photoUrls":["string"],"friend":{"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},"tags":[{"id":0,"name":"string"}],"status":"available","petType":"string"}
    Properties:
    • id
      integer:int64
      Id
      Pet ID
      Find more info here
      External Docs
      Example: 0
      ReadOnly
    • category
      object
      Category
      Categories this pet belongs to
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      The name given to a pet
      Example: "Guru"
    • photoUrls
      array<string:url>
      Required
      The list of URL to a cute photos featuring pet
      Example: ["string"]
      Maximum number of items: 20
      Items:
      • string:url
        Example: "string"
    • friend
      object
      Pet
      Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"}
    • tags
      array
      Tags attached to the pet
      Example: [{"id":0,"name":"string"}]
      Maximum number of items: 1
      Items:
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • status
      string
      Pet status in the store
      Example: "available"
      Enum: available pending sold
    • petType
      string
      Type of a pet
      Example: "string"

Tag

  • object
    Example: {"id":0,"name":"string"}
    Properties:
    • id
      integer:int64
      Id
      Tag ID
      Example: 0
      ReadOnly
    • name
      string
      Tag name
      Example: "string"
      Minimum string length: 1

User

  • object
    Example: {"id":0,"pet":{"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},"username":"John78","firstName":"John","lastName":"Smith","email":"john.smith@example.com","password":"drowssaP123","phone":"+1-202-555-0192","userStatus":0}
    Properties:
    • id
      integer:int64
      Id
      Example: 0
      ReadOnly
    • pet
      object
      Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"}
      One Of:
      • object
        Pet
        Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"}
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • username
      string
      User supplied username
      Example: "John78"
      Minimum string length: 4
    • firstName
      string
      User first name
      Example: "John"
      Minimum string length: 1
    • lastName
      string
      User last name
      Example: "Smith"
      Minimum string length: 1
    • email
      string:email
      User email address
      Example: "john.smith@example.com"
    • password
      string:password
      User password, MUST contain a mix of upper and lower case letters, as well as digits
      Example: "drowssaP123"
      Minimum string length: 8
      Pattern: /(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/
    • phone
      string or null
      User phone number in international format
      Example: "+1-202-555-0192"
      Pattern: /^\+(?:[0-9]-?){6,14}[0-9]$/
    • userStatus
      integer:int32
      User status
      Example: 0

Examples

Order

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

Request Bodies

Pet

Required
Pet object that needs to be added to the store
Content Type:
application/json
  • Schema
  • object
    Pet
    My Pet
    Example: {"id":0,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"}
    Properties:
    • id
      integer:int64
      Required
      Example: 0
    • category
      object
      Category
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      Example: "doggie"
    • photoUrls
      array<string>
      Required
      Example: ["string"]
      Items:
      • string
        Example: "string"
    • tags
      array
      Example: [{"id":0,"name":"string"}]
      Items:
      • object
        Tag
        Example: {"id":0,"name":"string"}
    • status
      string
      pet status in the store
      Example: "available"
      Enum: available pending sold

UserArray

Required
List of user object
Content Type:
application/json
  • Schema
  • array
    Example: [{"id":0,"username":"string","firstName":"string","lastName":"string","email":"string","password":"string","phone":"string","userStatus":0}]
    Items:
    • object
      User
      Example: {"id":0,"username":"string","firstName":"string","lastName":"string","email":"string","password":"string","phone":"string","userStatus":0}