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 | Control Type | Description | Required |
---|---|---|---|---|---|
clientId | Client Id | STRING | TEXT | true | |
clientSecret | Client Secret | STRING | TEXT | true |
API Key
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
key | Key | STRING | TEXT | true | |
value | Value | STRING | TEXT | true |
Actions
Add a new pet to the store
Name: addPet
Add a new pet to the store
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
pet | Pet | {INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)} | OBJECT_BUILDER | true |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
name | Name | STRING |
category | Category | {INTEGER(id), STRING(name)} |
photoUrls | Photo Urls | [STRING] |
tags | Tags | [{INTEGER(id), STRING(name)}] |
status | Status | STRING |
Update an existing pet
Name: updatePet
Update an existing pet by Id
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
pet | Pet | {INTEGER(id), STRING(name), {INTEGER(id), STRING(name)}(category), [STRING](photoUrls), [{INTEGER(id), STRING(name)}](tags), STRING(status)} | OBJECT_BUILDER | true |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
name | Name | STRING |
category | Category | {INTEGER(id), STRING(name)} |
photoUrls | Photo Urls | [STRING] |
tags | Tags | [{INTEGER(id), STRING(name)}] |
status | Status | STRING |
Finds Pets by status
Name: findPetsByStatus
Multiple status values can be provided with comma separated strings
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
status | Status | STRING | SELECT | Status values that need to be considered for filter | false |
Output
Type: ARRAY
Properties
Name | Type | Control 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
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
tags | Tags | [STRING] | ARRAY_BUILDER | Tags to filter by | false |
Output
Type: ARRAY
Properties
Name | Type | Control 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
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
api_key | Api Key | STRING | TEXT | false | |
petId | Pet Id | INTEGER | INTEGER | Pet id to delete | true |
Find pet by ID
Name: getPetById
Returns a single pet
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
petId | Pet Id | INTEGER | INTEGER | ID of pet to return | true |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
name | Name | STRING |
category | Category | {INTEGER(id), STRING(name)} |
photoUrls | Photo Urls | [STRING] |
tags | Tags | [{INTEGER(id), STRING(name)}] |
status | Status | STRING |
Updates a pet in the store with form data
Name: updatePetWithForm
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
petId | Pet Id | INTEGER | INTEGER | ID of pet that needs to be updated | true |
name | Name | STRING | TEXT | Name of pet that needs to be updated | false |
status | Status | STRING | TEXT | Status of pet that needs to be updated | false |
uploads an image
Name: uploadFile
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
petId | Pet Id | INTEGER | INTEGER | ID of pet to update | true |
additionalMetadata | Additional Metadata | STRING | TEXT | Additional Metadata | false |
fileEntry | FILE_ENTRY | FILE_ENTRY |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
code | Code | INTEGER |
type | Type | STRING |
message | Message | STRING |
Returns pet inventories by status
Name: getInventory
Returns a map of status codes to quantities
Properties
Name | Label | Type | Control Type | Description | Required |
---|
Output
Type: OBJECT
Place an order for a pet
Name: placeOrder
Place a new order in the store
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
order | Order | {INTEGER(id), INTEGER(petId), INTEGER(quantity), DATE_TIME(shipDate), STRING(status), BOOLEAN(complete)} | OBJECT_BUILDER | null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
petId | Pet Id | INTEGER |
quantity | Quantity | INTEGER |
shipDate | Ship Date | DATE_TIME |
status | Status | STRING |
complete | Complete | BOOLEAN |
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 | Control Type | Description | Required |
---|---|---|---|---|---|
orderId | Order Id | INTEGER | INTEGER | ID of the order that needs to be deleted | true |
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 | Control Type | Description | Required |
---|---|---|---|---|---|
orderId | Order Id | INTEGER | INTEGER | ID of order that needs to be fetched | true |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
petId | Pet Id | INTEGER |
quantity | Quantity | INTEGER |
shipDate | Ship Date | DATE_TIME |
status | Status | STRING |
complete | Complete | BOOLEAN |
Create user
Name: createUser
This can only be done by the logged in user.
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
user | User | {INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)} | OBJECT_BUILDER | null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
username | Username | STRING |
firstName | First Name | STRING |
lastName | Last Name | STRING |
STRING | ||
password | Password | STRING |
phone | Phone | STRING |
userStatus | User Status | INTEGER |
Creates list of users with given input array
Name: createUsersWithListInput
Creates list of users with given input array
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
__items | Items | [{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}] | ARRAY_BUILDER | null |
Output
Type: ARRAY
Properties
Name | Type | Control 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
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
username | Username | STRING | TEXT | The name that needs to be deleted | true |
Get user by user name
Name: getUserByName
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
username | Username | STRING | TEXT | The name that needs to be fetched. Use user1 for testing. | true |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
username | Username | STRING |
firstName | First Name | STRING |
lastName | Last Name | STRING |
STRING | ||
password | Password | STRING |
phone | Phone | STRING |
userStatus | User Status | INTEGER |
Update user
Name: updateUser
This can only be done by the logged in user.
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
username | Username | STRING | TEXT | name that need to be deleted | true |
user | User | {INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)} | OBJECT_BUILDER | null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
username | Username | STRING |
firstName | First Name | STRING |
lastName | Last Name | STRING |
STRING | ||
password | Password | STRING |
phone | Phone | STRING |
userStatus | User Status | INTEGER |