🐶 Schwager Petstore

1.0.0

Servers

Description

This is a sample server Petstore API spec.

URL

demoServerUrl
Description

This is a another URL.

URL

otherServerUrl

/login

Name: /login
Regex: /login

Endpoints

GETLogs user into the system
Response
- 200
  Context
  
  UserLoginGetController
  
  Headers
  
  Content-Type: application/json
  X-Expires-After: {UTC}
  X-Rate-Limit: {rateLimit}
  
  Body
  
  type: string regex: '^.*$'
- 400
  
  Context
  
  UserLoginGetController

/logout

Name: /logout
Regex: /logout

Endpoints

GETLogs out current logged in user session
Response
- 200
  Context
  
  UserLogoutGetController
  
  Body
  
  type: 'null'

/pet

Name: /pet
Regex: /pet

Endpoints

POSTAdd a new pet to the store

Request

Body

type: 'array#map'
parameters:
  id:
    type: int
  category:
    type: 'array#map'
    parameters:
      id:
        type: int
      name:
        type: string
        regex: '^.*$'
  name:
    type: string
    regex: '^.*$'
  photoUrls:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: string
            regex: '^.*$'
  tags:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: 'array#map'
            parameters:
              id:
                type: int
              name:
                type: string
                regex: '^.*$'
  status:
    type: string
    regex: \b(available|pending|sold)\b

Response

405
Context

PetsPostController

Headers

Content-Type: application/json

Body
```
type: 'null'
```

PUTUpdate an existing pet

Request

Body

type: 'array#map'
parameters:
  id:
    type: int
  category:
    type: 'array#map'
    parameters:
      id:
        type: int
      name:
        type: string
        regex: '^.*$'
  name:
    type: string
    regex: '^.*$'
  photoUrls:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: string
            regex: '^.*$'
  tags:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: 'array#map'
            parameters:
              id:
                type: int
              name:
                type: string
                regex: '^.*$'
  status:
    type: string
    regex: \b(available|pending|sold)\b

Response

400
Context

PetPutController

Headers

Content-Type: application/json

Body
```
type: 'null'
```
404

Context

PetPutController
405

Context

PetPutController

/pet/findByStatus

Name: /pet/findByStatus
Regex: /pet/findByStatus

Endpoints

GETFinds Pets by status

Request

Query string

status:
  type: string
  regex: \b(available|pending|sold)\b

Response

200

Context

PetsFindByStatusGetController

Headers

Content-Type: application/json

Body

type: union
parameters:
  -
    type: 'array#map'
  -
    type: iterable
    parameters:
      K:
        type: int
      V:
        type: 'array#map'
        parameters:
          id:
            type: int
          category:
            type: 'array#map'
            parameters:
              id:
                type: int
              name:
                type: string
                regex: '^.*$'
          name:
            type: string
            regex: '^.*$'
          photoUrls:
            type: union
            parameters:
              -
                type: 'array#map'
              -
                type: iterable
                parameters:
                  K:
                    type: int
                  V:
                    type: string
                    regex: '^.*$'
          tags:
            type: union
            parameters:
              -
                type: 'array#map'
              -
                type: iterable
                parameters:
                  K:
                    type: int
                  V:
                    type: 'array#map'
                    parameters:
                      id:
                        type: int
                      name:
                        type: string
                        regex: '^.*$'
          status:
            type: string
            regex: \b(available|pending|sold)\b

400

Context

PetsFindByStatusGetController

/pet/findByTags

Name: /pet/findByTags
Regex: /pet/findByTags

Endpoints

GETFinds Pets by tag

Request

Query string

tags:
  type: string
  description: 'Tags to filter by'
  regex: '^.*$'

Response

200

Context

PetsFindByTagGetController

Headers

Content-Type: application/json

Body

type: union
parameters:
  -
    type: 'array#map'
  -
    type: iterable
    parameters:
      K:
        type: int
      V:
        type: 'array#map'
        parameters:
          id:
            type: int
          category:
            type: 'array#map'
            parameters:
              id:
                type: int
              name:
                type: string
                regex: '^.*$'
          name:
            type: string
            regex: '^.*$'
          photoUrls:
            type: union
            parameters:
              -
                type: 'array#map'
              -
                type: iterable
                parameters:
                  K:
                    type: int
                  V:
                    type: string
                    regex: '^.*$'
          tags:
            type: union
            parameters:
              -
                type: 'array#map'
              -
                type: iterable
                parameters:
                  K:
                    type: int
                  V:
                    type: 'array#map'
                    parameters:
                      id:
                        type: int
                      name:
                        type: string
                        regex: '^.*$'
          status:
            type: string
            regex: \b(available|pending|sold)\b

400

Context

PetsFindByTagGetController

/pet/{petId}

Name

/pet/{petId}

Regex

^(?|/pet/(.*))$

Variables

{petId}

Type

string

Regex

^.*$

Description

ID of pet to return

Endpoints

DELETEDeletes a pet
Request
Body

type: 'array#map' parameters: api_key: type: string regex: '^.*$'
Response
- 400
  Context
  
  PetDeleteController
  
  Headers
  
  Content-Type: application/json
  
  Body
  
  type: 'null'
- 404
  
  Context
  
  PetDeleteController

GETFinds pet by ID

Request

Query string

status:
  type: string
  regex: \b(available|pending|sold)\b

Response

200

Context

PetGetController

Headers

Content-Type: application/json

Body

type: 'array#map'
parameters:
  id:
    type: int
  category:
    type: 'array#map'
    parameters:
      id:
        type: int
      name:
        type: string
        regex: '^.*$'
  name:
    type: string
    regex: '^.*$'
  photoUrls:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: string
            regex: '^.*$'
  tags:
    type: union
    parameters:
      -
        type: 'array#map'
      -
        type: iterable
        parameters:
          K:
            type: int
          V:
            type: 'array#map'
            parameters:
              id:
                type: int
              name:
                type: string
                regex: '^.*$'
  status:
    type: string
    regex: \b(available|pending|sold)\b

400

Context

PetGetController
404

Context

PetGetController

POSTUpdates a pet in the store with form data

Request

Body

type: 'array#map'
parameters:
  name:
    required: false
    type: string
    regex: '^.*$'
  status:
    required: false
    type: string
    regex: \b(available|pending|sold)\b

Response

405
Context

PetPostController

Headers

Content-Type: application/json

Body
```
type: 'null'
```

/pet/{petId}/uploadImage

Name

/pet/{petId}/uploadImage

Regex

^(?|/pet/(.*)/uploadImage)$

Variables

{petId}

Type

string

Regex

^.*$

Description

ID of pet to update

Endpoints

POSTuploads an image

Request

Body

type: 'array#map'
parameters:
  additionalMetadata:
    type: string
    description: 'Additional data to pass to server'
    regex: '^.*$'
  file:
    type: string
    regex: '^.*$'

Response

200

Context

UploadImagePostController

Headers

Content-Type: application/json

Body

type: 'array#map'
parameters:
  code:
    type: int
  type:
    type: string
    regex: '^.*$'
  message:
    type: string
    regex: '^.*$'

/store/inventory

Name: /store/inventory
Regex: /store/inventory

Endpoints

GETReturns pet inventories by status
Response
- 200
  Context
  
  StoreInventoryGetController
  
  Headers
  
  Content-Type: application/json
  
  Body
  
  type: iterable parameters: K: type: string regex: '^.*$' V: type: int

/store/order

Name: /store/order
Regex: /store/order

Endpoints

POSTPlace an order for a pet

Request

Body

type: 'array#map'
parameters:
  id:
    type: int
  petId:
    type: int
  quantity:
    type: int
  shipDate:
    type: string
    description: 'YYYY-MM-DD hh:mm:ss'
    regex: '^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])\s{1}\d{2,3}:[0-5][0-9]:[0-5][0-9]$'
  status:
    type: string
    regex: \b(placed|approved|delivered)\b
  complete:
    type: bool

Response

200

Context

StoreOrderPostController

Headers

Content-Type: application/json

Body

type: 'array#map'
parameters:
  id:
    type: int
  petId:
    type: int
  quantity:
    type: int
  shipDate:
    type: string
    description: 'YYYY-MM-DD hh:mm:ss'
    regex: '^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])\s{1}\d{2,3}:[0-5][0-9]:[0-5][0-9]$'
  status:
    type: string
    regex: \b(placed|approved|delivered)\b
  complete:
    type: bool

400

Context

StoreOrderPostController

/store/order/{orderId}

Name

/store/order/{orderId}

Regex

^(?|/store/order/(.*))$

Variables

{orderId}

Type

string

Regex

^.*$

Description

ID of pet that needs to be fetched

Endpoints

DELETEDelete purchase order by ID
Response
- 400
  Context
  
  StoreOrderDeleteController
  
  Headers
  
  Content-Type: application/json
  
  Body
  
  type: 'null'
- 404
  
  Context
  
  StoreOrderDeleteController

GETFind purchase order by ID

Response

200

Context

StoreOrderGetController

Headers

Content-Type: application/json

Body

type: 'array#map'
parameters:
  id:
    type: int
  petId:
    type: int
  quantity:
    type: int
  shipDate:
    type: string
    description: 'YYYY-MM-DD hh:mm:ss'
    regex: '^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])\s{1}\d{2,3}:[0-5][0-9]:[0-5][0-9]$'
  status:
    type: string
    regex: \b(placed|approved|delivered)\b
  complete:
    type: bool

400

Context

StoreOrderGetController
404

Context

StoreOrderGetController

/user

Name: /user
Regex: /user

Endpoints

POSTCreate user

Request

Body

type: 'array#map'
parameters:
  id:
    type: int
  username:
    type: string
    regex: '^.*$'
  firstName:
    type: string
    regex: '^.*$'
  lastName:
    type: string
    regex: '^.*$'
  email:
    type: string
    regex: '^.*$'
  password:
    type: string
    regex: '^.*$'
  phone:
    type: string
    regex: '^.*$'
  userStatus:
    type: int

Response

204
Context

UsersPostController

Body
```
type: 'null'
```

/user/createWithArray

Name: /user/createWithArray
Regex: /user/createWithArray

Endpoints

POSTCreates lists of users with given input array

Request

Body

type: 'array#map'
parameters:
  input:
    type: iterable
    parameters:
      K:
        type: int
      V:
        type: 'array#map'
        parameters:
          id:
            type: int
          username:
            type: string
            regex: '^.*$'
          firstName:
            type: string
            regex: '^.*$'
          lastName:
            type: string
            regex: '^.*$'
          email:
            type: string
            regex: '^.*$'
          password:
            type: string
            regex: '^.*$'
          phone:
            type: string
            regex: '^.*$'
          userStatus:
            type: int

Response

200
Context

UserCreateWithArrayPostController

Headers

Content-Type: application/json

Body
```
type: 'null'
```

/user/createWithList

Name: /user/createWithList
Regex: /user/createWithList

Endpoints

POSTCreates lists of users with given input array

Request

Body

type: 'array#map'
parameters:
  input:
    type: iterable
    parameters:
      K:
        type: int
      V:
        type: 'array#map'
        parameters:
          id:
            type: int
          username:
            type: string
            regex: '^.*$'
          firstName:
            type: string
            regex: '^.*$'
          lastName:
            type: string
            regex: '^.*$'
          email:
            type: string
            regex: '^.*$'
          password:
            type: string
            regex: '^.*$'
          phone:
            type: string
            regex: '^.*$'
          userStatus:
            type: int

Response

200
Context

UserCreateWithListPostController

Headers

Content-Type: application/json

Body
```
type: 'null'
```

/user/{username}

Name

/user/{username}

Regex

^(?|/user/(.*))$

Variables

{username}

Type

string

Regex

^.*$

Description

The name that needs to be fetched

Endpoints

DELETEDelete user
Response
- 400
  Context
  
  UserDeleteController
  
  Headers
  
  Content-Type: application/json
  
  Body
  
  type: 'null'
- 404
  
  Context
  
  UserDeleteController

GETGet user by user name

Response

200

Context

UserGetController

Headers

Content-Type: application/json

Body

type: 'array#map'
parameters:
  id:
    type: int
  username:
    type: string
    regex: '^.*$'
  firstName:
    type: string
    regex: '^.*$'
  lastName:
    type: string
    regex: '^.*$'
  email:
    type: string
    regex: '^.*$'
  password:
    type: string
    regex: '^.*$'
  phone:
    type: string
    regex: '^.*$'
  userStatus:
    type: int

400

Context

UserGetController
404

Context

UserGetController

PUTUpdated user
Response
- 400
  Context
  
  UserPutController
  
  Headers
  
  Content-Type: application/json
  
  Body
  
  type: 'null'
- 404
  
  Context
  
  UserPutController

🐶 Schwager Petstore

Servers

/login

GETLogs user into the system

/logout

GETLogs out current logged in user session

/pet

POSTAdd a new pet to the store

PUTUpdate an existing pet

/pet/findByStatus

GETFinds Pets by status

/pet/findByTags

GETFinds Pets by tag

/pet/{petId}

DELETEDeletes a pet

GETFinds pet by ID

POSTUpdates a pet in the store with form data

/pet/{petId}/uploadImage

POSTuploads an image

/store/inventory

GETReturns pet inventories by status

/store/order

POSTPlace an order for a pet

/store/order/{orderId}

DELETEDelete purchase order by ID

GETFind purchase order by ID

/user

POSTCreate user

/user/createWithArray

POSTCreates lists of users with given input array

/user/createWithList

POSTCreates lists of users with given input array

/user/{username}

DELETEDelete user

GETGet user by user name

PUTUpdated user