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

Pet

  • object
    Example: {"id":null,"category":{"id":0,"name":"string"},"name":"Guru"}
    Properties:
    • id
      any
      Pet ID
      Find more info here
      External Docs
      Example: null
    • category
      object
      Category
      Categories this pet belongs to
      Example: {"id":0,"name":"string"}
    • name
      string
      Required
      The name given to a pet
      Example: "Guru"

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

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}