3df525ee33
* Add support for enum schemas and properties to the rust generator Also: * Skip serializing a field with serde if it's optional and empty * Fix borrow checker error when using &std::path::Path (should be std::path::PathBuf) * Add script to generate sample with rust-reqwest * Regenerate petstore sample for both rust targets * Remove go code from README.md * Fix formatting of serde skip_serializing_if attribute
8.3 KiB
\PetApi
All URIs are relative to http://petstore.swagger.io/v2
| Method | 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 |
| get_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(ctx, body) Add a new pet to the store
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| 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 defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_pet
delete_pet(ctx, pet_id, optional) Deletes a pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| pet_id | i64 | Pet id to delete | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | i64 | Pet id to delete | |
| api_key | String |
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
Vec<::models::Pet> find_pets_by_status(ctx, status) Finds Pets by status
Multiple status values can be provided with comma separated strings
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| status | Vec | 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
Vec<::models::Pet> find_pets_by_tags(ctx, tags) Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| tags | Vec | 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]
get_pet_by_id
::models::Pet get_pet_by_id(ctx, pet_id) Find pet by ID
Returns a single pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| pet_id | i64 | 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(ctx, body) Update an existing pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| 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 defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_pet_with_form
update_pet_with_form(ctx, pet_id, optional) Updates a pet in the store with form data
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| pet_id | i64 | ID of pet that needs to be updated | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | i64 | ID of pet that needs to be updated | |
| name | String | Updated name of the pet | |
| status | String | Updated status of the pet |
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
::models::ApiResponse upload_file(ctx, pet_id, optional) uploads an image
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context containing the authentication | nil if no authentication |
| pet_id | i64 | ID of pet to update | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| pet_id | i64 | ID of pet to update | |
| additional_metadata | String | Additional data to pass to server | |
| file | std::path::PathBuf | file to upload |
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]