Petstore

This is a sample Pet Store Server based on the OpenAPI 3.0 specification.

Type: petstore/v1

Connections

Version: 1

OAuth2 Implicit

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

API Key

Properties

Name	Label	Type	Description	Required
key	Key	STRING		true
value	Value	STRING		true

Actions

Add a new pet to the store

Name: addPet

Add a new pet to the store

Properties

Name	Label	Type	Description	Required
id	Id	INTEGER		false
name	Name	STRING		true
category	Category	OBJECT Properties {INTEGER(id), STRING(name)}		false
photoUrls	Photo Urls	ARRAY Items [STRING]		true
tags	Tags	ARRAY Items [{INTEGER(id), STRING(name)}]		false
status	Status	STRING Options available, pending, sold	`pet status in the store`	false

Example JSON Structure

{
  "label" : "Add a new pet to the store",
  "name" : "addPet",
  "parameters" : {
    "id" : 1,
    "name" : "",
    "category" : {
      "id" : 1,
      "name" : ""
    },
    "photoUrls" : [ "" ],
    "tags" : [ {
      "id" : 1,
      "name" : ""
    } ],
    "status" : ""
  },
  "type" : "petstore/v1/addPet"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
name	STRING
category	OBJECT Properties {INTEGER(id), STRING(name)}
photoUrls	ARRAY Items [STRING]
tags	ARRAY Items [{INTEGER(id), STRING(name)}]
status	STRING Options available, pending, sold	pet status in the store

Output Example

{
  "id" : 1,
  "name" : "",
  "category" : {
    "id" : 1,
    "name" : ""
  },
  "photoUrls" : [ "" ],
  "tags" : [ {
    "id" : 1,
    "name" : ""
  } ],
  "status" : ""
}

Update an existing pet

Name: updatePet

Update an existing pet by Id

Properties

Name	Label	Type	Description	Required
id	Id	INTEGER		false
name	Name	STRING		true
category	Category	OBJECT Properties {INTEGER(id), STRING(name)}		false
photoUrls	Photo Urls	ARRAY Items [STRING]		true
tags	Tags	ARRAY Items [{INTEGER(id), STRING(name)}]		false
status	Status	STRING Options available, pending, sold	`pet status in the store`	false

Example JSON Structure

{
  "label" : "Update an existing pet",
  "name" : "updatePet",
  "parameters" : {
    "id" : 1,
    "name" : "",
    "category" : {
      "id" : 1,
      "name" : ""
    },
    "photoUrls" : [ "" ],
    "tags" : [ {
      "id" : 1,
      "name" : ""
    } ],
    "status" : ""
  },
  "type" : "petstore/v1/updatePet"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
name	STRING
category	OBJECT Properties {INTEGER(id), STRING(name)}
photoUrls	ARRAY Items [STRING]
tags	ARRAY Items [{INTEGER(id), STRING(name)}]
status	STRING Options available, pending, sold	pet status in the store

Output Example

{
  "id" : 1,
  "name" : "",
  "category" : {
    "id" : 1,
    "name" : ""
  },
  "photoUrls" : [ "" ],
  "tags" : [ {
    "id" : 1,
    "name" : ""
  } ],
  "status" : ""
}

Finds Pets by status

Name: findPetsByStatus

Multiple status values can be provided with comma separated strings

Properties

Name	Label	Type	Description	Required
status	Status	STRING Options available, pending, sold	`Status values that need to be considered for filter`	false

Example JSON Structure

{
  "label" : "Finds Pets by status",
  "name" : "findPetsByStatus",
  "parameters" : {
    "status" : ""
  },
  "type" : "petstore/v1/findPetsByStatus"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
name	STRING
category	OBJECT Properties {INTEGER(id), STRING(name)}
photoUrls	ARRAY Items [STRING]
tags	ARRAY Items [{INTEGER(id), STRING(name)}]
status	STRING Options available, pending, sold	pet status in the store

Output Example

[ {
  "id" : 1,
  "name" : "",
  "category" : {
    "id" : 1,
    "name" : ""
  },
  "photoUrls" : [ "" ],
  "tags" : [ {
    "id" : 1,
    "name" : ""
  } ],
  "status" : ""
} ]

Finds Pets by tags

Name: findPetsByTags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Properties

Name	Label	Type	Description	Required
tags	Tags	ARRAY Items [STRING]	`Tags to filter by`	false

Example JSON Structure

{
  "label" : "Finds Pets by tags",
  "name" : "findPetsByTags",
  "parameters" : {
    "tags" : [ "" ]
  },
  "type" : "petstore/v1/findPetsByTags"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
name	STRING
category	OBJECT Properties {INTEGER(id), STRING(name)}
photoUrls	ARRAY Items [STRING]
tags	ARRAY Items [{INTEGER(id), STRING(name)}]
status	STRING Options available, pending, sold	pet status in the store

Output Example

[ {
  "id" : 1,
  "name" : "",
  "category" : {
    "id" : 1,
    "name" : ""
  },
  "photoUrls" : [ "" ],
  "tags" : [ {
    "id" : 1,
    "name" : ""
  } ],
  "status" : ""
} ]

Deletes a pet

Name: deletePet

delete a pet

Properties

Name	Label	Type	Description	Required
api_key	Api Key	STRING	``	false
petId	Pet Id	INTEGER	`Pet id to delete`	true

Example JSON Structure

{
  "label" : "Deletes a pet",
  "name" : "deletePet",
  "parameters" : {
    "api_key" : "",
    "petId" : 1
  },
  "type" : "petstore/v1/deletePet"
}

Output

This action does not produce any output.

Find pet by ID

Name: getPetById

Returns a single pet

Properties

Name	Label	Type	Description	Required
petId	Pet Id	INTEGER	`ID of pet to return`	true

Example JSON Structure

{
  "label" : "Find pet by ID",
  "name" : "getPetById",
  "parameters" : {
    "petId" : 1
  },
  "type" : "petstore/v1/getPetById"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
name	STRING
category	OBJECT Properties {INTEGER(id), STRING(name)}
photoUrls	ARRAY Items [STRING]
tags	ARRAY Items [{INTEGER(id), STRING(name)}]
status	STRING Options available, pending, sold	pet status in the store

Output Example

{
  "id" : 1,
  "name" : "",
  "category" : {
    "id" : 1,
    "name" : ""
  },
  "photoUrls" : [ "" ],
  "tags" : [ {
    "id" : 1,
    "name" : ""
  } ],
  "status" : ""
}

Updates a pet in the store with form data

Name: updatePetWithForm

Properties

Name	Label	Type	Description	Required
petId	Pet Id	INTEGER	`ID of pet that needs to be updated`	true
name	Name	STRING	`Name of pet that needs to be updated`	false
status	Status	STRING	`Status of pet that needs to be updated`	false

Example JSON Structure

{
  "label" : "Updates a pet in the store with form data",
  "name" : "updatePetWithForm",
  "parameters" : {
    "petId" : 1,
    "name" : "",
    "status" : ""
  },
  "type" : "petstore/v1/updatePetWithForm"
}

Output

This action does not produce any output.

uploads an image

Name: uploadFile

Properties

Name	Label	Type	Description	Required
petId	Pet Id	INTEGER	`ID of pet to update`	true
additionalMetadata	Additional Metadata	STRING	`Additional Metadata`	false
fileEntry		FILE_ENTRY		null

Example JSON Structure

{
  "label" : "uploads an image",
  "name" : "uploadFile",
  "parameters" : {
    "petId" : 1,
    "additionalMetadata" : "",
    "fileEntry" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    }
  },
  "type" : "petstore/v1/uploadFile"
}

Output

Type: OBJECT

Properties

Name	Type	Description
code	INTEGER
type	STRING
message	STRING

Output Example

{
  "code" : 1,
  "type" : "",
  "message" : ""
}

Returns pet inventories by status

Name: getInventory

Returns a map of status codes to quantities

Example JSON Structure

{
  "label" : "Returns pet inventories by status",
  "name" : "getInventory",
  "type" : "petstore/v1/getInventory"
}

Output

Type: OBJECT

Place an order for a pet

Name: placeOrder

Place a new order in the store

Properties

Name	Label	Type	Description	Required
id	Id	INTEGER		false
petId	Pet Id	INTEGER		false
quantity	Quantity	INTEGER		false
shipDate	Ship Date	DATE_TIME		false
status	Status	STRING Options placed, approved, delivered	`Order Status`	false
complete	Complete	BOOLEAN Options true, false		false

Example JSON Structure

{
  "label" : "Place an order for a pet",
  "name" : "placeOrder",
  "parameters" : {
    "id" : 1,
    "petId" : 1,
    "quantity" : 1,
    "shipDate" : "2021-01-01T00:00:00",
    "status" : "",
    "complete" : false
  },
  "type" : "petstore/v1/placeOrder"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
petId	INTEGER
quantity	INTEGER
shipDate	DATE_TIME
status	STRING Options placed, approved, delivered	Order Status
complete	BOOLEAN Options true, false

Output Example

{
  "id" : 1,
  "petId" : 1,
  "quantity" : 1,
  "shipDate" : "2021-01-01T00:00:00",
  "status" : "",
  "complete" : false
}

Delete purchase order by ID

Name: deleteOrder

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Properties

Name	Label	Type	Description	Required
orderId	Order Id	INTEGER	`ID of the order that needs to be deleted`	true

Example JSON Structure

{
  "label" : "Delete purchase order by ID",
  "name" : "deleteOrder",
  "parameters" : {
    "orderId" : 1
  },
  "type" : "petstore/v1/deleteOrder"
}

Output

This action does not produce any output.

Find purchase order by ID

Name: getOrderById

For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.

Properties

Name	Label	Type	Description	Required
orderId	Order Id	INTEGER	`ID of order that needs to be fetched`	true

Example JSON Structure

{
  "label" : "Find purchase order by ID",
  "name" : "getOrderById",
  "parameters" : {
    "orderId" : 1
  },
  "type" : "petstore/v1/getOrderById"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
petId	INTEGER
quantity	INTEGER
shipDate	DATE_TIME
status	STRING Options placed, approved, delivered	Order Status
complete	BOOLEAN Options true, false

Output Example

{
  "id" : 1,
  "petId" : 1,
  "quantity" : 1,
  "shipDate" : "2021-01-01T00:00:00",
  "status" : "",
  "complete" : false
}

Create user

Name: createUser

This can only be done by the logged in user.

Properties

Name	Label	Type	Description	Required
id	Id	INTEGER		false
username	Username	STRING		false
firstName	First Name	STRING		false
lastName	Last Name	STRING		false
email	Email	STRING		false
password	Password	STRING		false
phone	Phone	STRING		false
userStatus	User Status	INTEGER	`User Status`	false

Example JSON Structure

{
  "label" : "Create user",
  "name" : "createUser",
  "parameters" : {
    "id" : 1,
    "username" : "",
    "firstName" : "",
    "lastName" : "",
    "email" : "",
    "password" : "",
    "phone" : "",
    "userStatus" : 1
  },
  "type" : "petstore/v1/createUser"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
username	STRING
firstName	STRING
lastName	STRING
email	STRING
password	STRING
phone	STRING
userStatus	INTEGER	User Status

Output Example

{
  "id" : 1,
  "username" : "",
  "firstName" : "",
  "lastName" : "",
  "email" : "",
  "password" : "",
  "phone" : "",
  "userStatus" : 1
}

Creates list of users with given input array

Name: createUsersWithListInput

Creates list of users with given input array

Properties

Name	Label	Type	Description	Required
__items	Items	ARRAY Items [{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}]		null

Example JSON Structure

{
  "label" : "Creates list of users with given input array",
  "name" : "createUsersWithListInput",
  "parameters" : {
    "__items" : [ {
      "id" : 1,
      "username" : "",
      "firstName" : "",
      "lastName" : "",
      "email" : "",
      "password" : "",
      "phone" : "",
      "userStatus" : 1
    } ]
  },
  "type" : "petstore/v1/createUsersWithListInput"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
username	STRING
firstName	STRING
lastName	STRING
email	STRING
password	STRING
phone	STRING
userStatus	INTEGER	User Status

Output Example

[ {
  "id" : 1,
  "username" : "",
  "firstName" : "",
  "lastName" : "",
  "email" : "",
  "password" : "",
  "phone" : "",
  "userStatus" : 1
} ]

Delete user

Name: deleteUser

This can only be done by the logged in user.

Properties

Name	Label	Type	Description	Required
username	Username	STRING	`The name that needs to be deleted`	true

Example JSON Structure

{
  "label" : "Delete user",
  "name" : "deleteUser",
  "parameters" : {
    "username" : ""
  },
  "type" : "petstore/v1/deleteUser"
}

Output

This action does not produce any output.

Get user by user name

Name: getUserByName

Properties

Name	Label	Type	Description	Required
username	Username	STRING	`The name that needs to be fetched. Use user1 for testing.`	true

Example JSON Structure

{
  "label" : "Get user by user name",
  "name" : "getUserByName",
  "parameters" : {
    "username" : ""
  },
  "type" : "petstore/v1/getUserByName"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
username	STRING
firstName	STRING
lastName	STRING
email	STRING
password	STRING
phone	STRING
userStatus	INTEGER	User Status

Output Example

{
  "id" : 1,
  "username" : "",
  "firstName" : "",
  "lastName" : "",
  "email" : "",
  "password" : "",
  "phone" : "",
  "userStatus" : 1
}

Update user

Name: updateUser

This can only be done by the logged in user.

Properties

Name	Label	Type	Description	Required
username	Username	STRING	`name that need to be deleted`	true
id	Id	INTEGER		false
username	Username	STRING		false
firstName	First Name	STRING		false
lastName	Last Name	STRING		false
email	Email	STRING		false
password	Password	STRING		false
phone	Phone	STRING		false
userStatus	User Status	INTEGER	`User Status`	false

Example JSON Structure

{
  "label" : "Update user",
  "name" : "updateUser",
  "parameters" : {
    "username" : "",
    "id" : 1,
    "firstName" : "",
    "lastName" : "",
    "email" : "",
    "password" : "",
    "phone" : "",
    "userStatus" : 1
  },
  "type" : "petstore/v1/updateUser"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	INTEGER
username	STRING
firstName	STRING
lastName	STRING
email	STRING
password	STRING
phone	STRING
userStatus	INTEGER	User Status

Output Example

{
  "id" : 1,
  "username" : "",
  "firstName" : "",
  "lastName" : "",
  "email" : "",
  "password" : "",
  "phone" : "",
  "userStatus" : 1
}

On this page