6.8 KiB
PET_API
All URIs are relative to http://petstore.swagger.io:80/v2
| Feature | HTTP request | Description |
|---|---|---|
| add_pet | Post /pet | Add a new pet to the store |
| delete_pet | Delete /pet/{petId} | Deletes a pet |
| find_pets_by_status | Get /pet/findByStatus | Finds Pets by status |
| find_pets_by_tags | Get /pet/findByTags | Finds Pets by tags |
| pet_by_id | Get /pet/{petId} | Find pet by ID |
| update_pet | Put /pet | Update an existing pet |
| update_pet_with_form | Post /pet/{petId} | Updates a pet in the store with form data |
| upload_file | Post /pet/{petId}/uploadImage | uploads an image |
add_pet
add_pet (pet: PET )
Add a new pet to the store
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet | PET | Pet object that needs to be added to the store |
Return type
{empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, application/xml
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_pet
delete_pet (pet_id: INTEGER_64 ; api_key: detachable STRING_32 )
Deletes a pet
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | INTEGER_64 | Pet id to delete | |
| api_key | STRING_32 | [optional] |
Return type
{empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
find_pets_by_status
find_pets_by_status (status: LIST [STRING_32] ): detachable LIST [PET]
Finds Pets by status
Multiple status values can be provided with comma separated strings
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | LIST [STRING_32] | Status values that need to be considered for filter |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
find_pets_by_tags
find_pets_by_tags (tags: LIST [STRING_32] ): detachable LIST [PET]
Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tags | LIST [STRING_32] | Tags to filter by |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pet_by_id
pet_by_id (pet_id: INTEGER_64 ): detachable PET
Find pet by ID
Returns a single pet
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | INTEGER_64 | ID of pet to return |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_pet
update_pet (pet: PET )
Update an existing pet
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet | PET | Pet object that needs to be added to the store |
Return type
{empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, application/xml
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_pet_with_form
update_pet_with_form (pet_id: INTEGER_64 ; name: detachable STRING_32 ; status: detachable STRING_32 )
Updates a pet in the store with form data
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | INTEGER_64 | ID of pet that needs to be updated | |
| name | STRING_32 | Updated name of the pet | [optional] [default to null] |
| status | STRING_32 | Updated status of the pet | [optional] [default to null] |
Return type
{empty response body)
Authorization
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upload_file
upload_file (pet_id: INTEGER_64 ; additional_metadata: detachable STRING_32 ; file: detachable FILE ): detachable API_RESPONSE
uploads an image
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | INTEGER_64 | ID of pet to update | |
| additional_metadata | STRING_32 | Additional data to pass to server | [optional] [default to null] |
| file | FILE | file to upload | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]