PSDemo Developer’s Guide¶
TBD
Introduction¶
TBD
API for some functionality¶
TBD
Pet Store APIs¶
pet¶
POST /pet/{petId}/uploadImage
uploads an image
- Description:
- Consumes: [‘multipart/form-data’]
- Produces: [‘application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| petId | path | ID of pet to update | integer |
| additionalMetadata | formData | Additional data to pass to server | string |
| file | formData | file to upload | file |
Responses
200 - successful operation
POST /pet
Add a new pet to the store
- Description:
- Consumes: [‘application/json’, ‘application/xml’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Pet object that needs to be added to the store |
Responses
405 - Invalid input
PUT /pet
Update an existing pet
- Description:
- Consumes: [‘application/json’, ‘application/xml’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Pet object that needs to be added to the store |
Responses
400 - Invalid ID supplied
404 - Pet not found
405 - Validation exception
GET /pet/findByStatus
Finds Pets by status
- Description: Multiple status values can be provided with comma separated strings
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| status | query | Status values that need to be considered for filter | array |
Responses
200 - successful operation
400 - Invalid status value
GET /pet/findByTags
Finds Pets by tags
- Description: Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| tags | query | Tags to filter by | array |
Responses
200 - successful operation
400 - Invalid tag value
GET /pet/{petId}
Find pet by ID
- Description: Returns a single pet
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| petId | path | ID of pet to return | integer |
Responses
200 - successful operation
400 - Invalid ID supplied
404 - Pet not found
POST /pet/{petId}
Updates a pet in the store with form data
- Description:
- Consumes: [‘application/x-www-form-urlencoded’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| petId | path | ID of pet that needs to be updated | integer |
| name | formData | Updated name of the pet | string |
| status | formData | Updated status of the pet | string |
Responses
405 - Invalid input
DELETE /pet/{petId}
Deletes a pet
- Description:
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| api_key | header | string | |
| petId | path | Pet id to delete | integer |
Responses
400 - Invalid ID supplied
404 - Pet not found
store¶
POST /store/order
Place an order for a pet
- Description:
- Consumes: [‘application/json’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | order placed for purchasing the pet |
Responses
200 - successful operation
400 - Invalid Order
GET /store/order/{orderId}
Find purchase order by ID
- Description: For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| orderId | path | ID of pet that needs to be fetched | integer |
Responses
200 - successful operation
400 - Invalid ID supplied
404 - Order not found
DELETE /store/order/{orderId}
Delete purchase order by ID
- Description: For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| orderId | path | ID of the order that needs to be deleted | integer |
Responses
400 - Invalid ID supplied
404 - Order not found
GET /store/inventory
Returns pet inventories by status
- Description: Returns a map of status codes to quantities
- Produces: [‘application/json’]
Parameters
| Name | Position | Description | Type |
|---|
Responses
200 - successful operation
user¶
POST /user/createWithArray
Creates list of users with given input array
- Description:
- Consumes: [‘application/json’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | List of user object |
Responses
default - successful operation
POST /user/createWithList
Creates list of users with given input array
- Description:
- Consumes: [‘application/json’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | List of user object |
Responses
default - successful operation
GET /user/{username}
Get user by user name
- Description:
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| username | path | The name that needs to be fetched. Use user1 for testing. | string |
Responses
200 - successful operation
400 - Invalid username supplied
404 - User not found
PUT /user/{username}
Updated user
- Description: This can only be done by the logged in user.
- Consumes: [‘application/json’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| username | path | name that need to be updated | string |
| body | body | Updated user object |
Responses
400 - Invalid user supplied
404 - User not found
DELETE /user/{username}
Delete user
- Description: This can only be done by the logged in user.
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| username | path | The name that needs to be deleted | string |
Responses
400 - Invalid username supplied
404 - User not found
GET /user/login
Logs user into the system
- Description:
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| username | query | The user name for login | string |
| password | query | The password for login in clear text | string |
Responses
200 - successful operation
400 - Invalid username/password supplied
GET /user/logout
Logs out current logged in user session
- Description:
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|
Responses
default - successful operation
POST /user
Create user
- Description: This can only be done by the logged in user.
- Consumes: [‘application/json’]
- Produces: [‘application/json’, ‘application/xml’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Created user object |
Responses
default - successful operation
Example Code¶
Perform the setup using the following commands
bash xyz.py -o <outputfile> -d <inputdir> -t <type>