946d145d30
* Update Dockerfile.mustache Using alpine instead of ubuntu for leaner Docker images. Small fix for welcome message. Changing default shell to `zsh` and fixing entrypoint. * update samples * move config, add new files Co-authored-by: avbenavides <62693723+avbenavides@users.noreply.github.com>
7.9 KiB
PetApi
All URIs are relative to /v2
| Method | HTTP request | Description |
|---|---|---|
| addPet | POST /pet | Add a new pet to the store |
| deletePet | DELETE /pet/{petId} | Deletes a pet |
| findPetsByStatus | GET /pet/findByStatus | Finds Pets by status |
| findPetsByTags | GET /pet/findByTags | Finds Pets by tags |
| getPetById | GET /pet/{petId} | Find pet by ID |
| updatePet | PUT /pet | Update an existing pet |
| updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data |
| uploadFile | POST /pet/{petId}/uploadImage | uploads an image |
| uploadFileWithRequiredFile | POST /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
addPet
Add a new pet to the store
Example
petstore-cli addPet
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | 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 Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deletePet
Deletes a pet
Example
petstore-cli deletePet petId=value api_key:value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| petId | integer | Pet id to delete | [default to null] |
| apiKey | string | [optional] [default to null] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
findPetsByStatus
Finds Pets by status
Multiple status values can be provided with comma separated strings
Example
petstore-cli findPetsByStatus Specify as: status="value1,value2,..."
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | array[string] | Status values that need to be considered for filter | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
findPetsByTags
Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
Example
petstore-cli findPetsByTags Specify as: tags="value1,value2,..."
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tags | Set[string] | Tags to filter by | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getPetById
Find pet by ID
Returns a single pet
Example
petstore-cli getPetById petId=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| petId | integer | ID of pet to return | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updatePet
Update an existing pet
Example
petstore-cli updatePet
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | 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 Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updatePetWithForm
Updates a pet in the store with form data
Example
petstore-cli updatePetWithForm petId=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| petId | integer | ID of pet that needs to be updated | [default to null] |
| name | string | Updated name of the pet | [optional] [default to null] |
| status | string | 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 Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
uploadFile
uploads an image
Example
petstore-cli uploadFile petId=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| petId | integer | ID of pet to update | [default to null] |
| additionalMetadata | string | Additional data to pass to server | [optional] [default to null] |
| file | binary | 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]
uploadFileWithRequiredFile
uploads an image (required)
Example
petstore-cli uploadFileWithRequiredFile petId=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| petId | integer | ID of pet to update | [default to null] |
| requiredFile | binary | file to upload | [default to null] |
| additionalMetadata | string | Additional data to pass to server | [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]