Skip to content

Petstore

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

Type: petstore/v1


Connections

Version: 1

OAuth2 Implicit

Properties

NameLabelTypeControl TypeDescriptionRequired
clientIdClient IdSTRINGTEXTtrue
clientSecretClient SecretSTRINGTEXTtrue

API Key

Properties

NameLabelTypeControl TypeDescriptionRequired
keyKeySTRINGTEXTtrue
valueValueSTRINGTEXTtrue

Actions

Add a new pet to the store

Name: addPet

Add a new pet to the store

Properties

NameLabelTypeControl TypeDescriptionRequired
petPet{INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)}OBJECT_BUILDERtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
nameNameSTRING
categoryCategory{INTEGER(id), STRING(name)}
photoUrlsPhoto Urls[STRING]
tagsTags[{INTEGER(id), STRING(name)}]
statusStatusSTRING

Update an existing pet

Name: updatePet

Update an existing pet by Id

Properties

NameLabelTypeControl TypeDescriptionRequired
petPet{INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)}OBJECT_BUILDERtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
nameNameSTRING
categoryCategory{INTEGER(id), STRING(name)}
photoUrlsPhoto Urls[STRING]
tagsTags[{INTEGER(id), STRING(name)}]
statusStatusSTRING

Finds Pets by status

Name: findPetsByStatus

Multiple status values can be provided with comma separated strings

Properties

NameLabelTypeControl TypeDescriptionRequired
statusStatusSTRINGSELECTStatus values that need to be considered for filterfalse

Output

Type: ARRAY

Properties

NameTypeControl Type
{INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)}OBJECT_BUILDER

Finds Pets by tags

Name: findPetsByTags

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

Properties

NameLabelTypeControl TypeDescriptionRequired
tagsTags[STRING]ARRAY_BUILDERTags to filter byfalse

Output

Type: ARRAY

Properties

NameTypeControl Type
{INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)}OBJECT_BUILDER

Deletes a pet

Name: deletePet

delete a pet

Properties

NameLabelTypeControl TypeDescriptionRequired
api_keyApi KeySTRINGTEXTfalse
petIdPet IdINTEGERINTEGERPet id to deletetrue

Find pet by ID

Name: getPetById

Returns a single pet

Properties

NameLabelTypeControl TypeDescriptionRequired
petIdPet IdINTEGERINTEGERID of pet to returntrue

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
nameNameSTRING
categoryCategory{INTEGER(id), STRING(name)}
photoUrlsPhoto Urls[STRING]
tagsTags[{INTEGER(id), STRING(name)}]
statusStatusSTRING

Updates a pet in the store with form data

Name: updatePetWithForm

Properties

NameLabelTypeControl TypeDescriptionRequired
petIdPet IdINTEGERINTEGERID of pet that needs to be updatedtrue
nameNameSTRINGTEXTName of pet that needs to be updatedfalse
statusStatusSTRINGTEXTStatus of pet that needs to be updatedfalse

uploads an image

Name: uploadFile

Properties

NameLabelTypeControl TypeDescriptionRequired
petIdPet IdINTEGERINTEGERID of pet to updatetrue
additionalMetadataAdditional MetadataSTRINGTEXTAdditional Metadatafalse
fileEntryFILE_ENTRYFILE_ENTRY

Output

Type: OBJECT

Properties

NameTypeControl Type
codeCodeINTEGER
typeTypeSTRING
messageMessageSTRING

Returns pet inventories by status

Name: getInventory

Returns a map of status codes to quantities

Properties

NameLabelTypeControl TypeDescriptionRequired

Output

Type: OBJECT

Place an order for a pet

Name: placeOrder

Place a new order in the store

Properties

NameLabelTypeControl TypeDescriptionRequired
orderOrder{INTEGER(id), INTEGER(petId), INTEGER(quantity), DATE_TIME(shipDate), STRING(status), BOOLEAN(complete)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
petIdPet IdINTEGER
quantityQuantityINTEGER
shipDateShip DateDATE_TIME
statusStatusSTRING
completeCompleteBOOLEAN

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

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IdINTEGERINTEGERID of the order that needs to be deletedtrue

Find purchase order by ID

Name: getOrderById

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

Properties

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IdINTEGERINTEGERID of order that needs to be fetchedtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
petIdPet IdINTEGER
quantityQuantityINTEGER
shipDateShip DateDATE_TIME
statusStatusSTRING
completeCompleteBOOLEAN

Create user

Name: createUser

This can only be done by the logged in user.

Properties

NameLabelTypeControl TypeDescriptionRequired
userUser{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
usernameUsernameSTRING
firstNameFirst NameSTRING
lastNameLast NameSTRING
emailEmailSTRING
passwordPasswordSTRING
phonePhoneSTRING
userStatusUser StatusINTEGER

Creates list of users with given input array

Name: createUsersWithListInput

Creates list of users with given input array

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemsItems[{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}]ARRAY_BUILDERnull

Output

Type: ARRAY

Properties

NameTypeControl Type
{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}OBJECT_BUILDER

Delete user

Name: deleteUser

This can only be done by the logged in user.

Properties

NameLabelTypeControl TypeDescriptionRequired
usernameUsernameSTRINGTEXTThe name that needs to be deletedtrue

Get user by user name

Name: getUserByName

Properties

NameLabelTypeControl TypeDescriptionRequired
usernameUsernameSTRINGTEXTThe name that needs to be fetched. Use user1 for testing.true

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
usernameUsernameSTRING
firstNameFirst NameSTRING
lastNameLast NameSTRING
emailEmailSTRING
passwordPasswordSTRING
phonePhoneSTRING
userStatusUser StatusINTEGER

Update user

Name: updateUser

This can only be done by the logged in user.

Properties

NameLabelTypeControl TypeDescriptionRequired
usernameUsernameSTRINGTEXTname that need to be deletedtrue
userUser{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
usernameUsernameSTRING
firstNameFirst NameSTRING
lastNameLast NameSTRING
emailEmailSTRING
passwordPasswordSTRING
phonePhoneSTRING
userStatusUser StatusINTEGER

Triggers