Benoît Courtine 28a16bea24 [Rust][Client] Correct the Rust client generated documentation (#3419)
Fixes #3418. Only generated API markdown files are impacted.
2019-07-24 17:33:11 +01:00

6.8 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(body) Add a new pet to the store

Parameters

Name Type Description Required Notes
body Pet Pet object that needs to be added to the store Required

Return type

(empty response body)

Authorization

petstore_auth

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, api_key) Deletes a pet

Parameters

Name Type Description Required Notes
pet_id i64 Pet id to delete Required
api_key String

Return type

(empty response body)

Authorization

petstore_auth

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

Veccrate::models::Pet find_pets_by_status(status) Finds Pets by status

Multiple status values can be provided with comma separated strings

Parameters

Name Type Description Required Notes
status Vec Status values that need to be considered for filter Required

Return type

Veccrate::models::Pet

Authorization

petstore_auth

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

Veccrate::models::Pet find_pets_by_tags(tags) Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Parameters

Name Type Description Required Notes
tags Vec Tags to filter by Required

Return type

Veccrate::models::Pet

Authorization

petstore_auth

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

crate::models::Pet get_pet_by_id(pet_id) Find pet by ID

Returns a single pet

Parameters

Name Type Description Required Notes
pet_id i64 ID of pet to return Required

Return type

crate::models::Pet

Authorization

api_key

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(body) Update an existing pet

Parameters

Name Type Description Required Notes
body Pet Pet object that needs to be added to the store Required

Return type

(empty response body)

Authorization

petstore_auth

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, name, status) Updates a pet in the store with form data

Parameters

Name Type Description Required Notes
pet_id i64 ID of pet that needs to be updated Required
name String Updated name of the pet
status String Updated status of the pet

Return type

(empty response body)

Authorization

petstore_auth

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

crate::models::ApiResponse upload_file(pet_id, additional_metadata, file) uploads an image

Parameters

Name Type Description Required Notes
pet_id i64 ID of pet to update Required
additional_metadata String Additional data to pass to server
file std::path::PathBuf file to upload

Return type

crate::models::ApiResponse

Authorization

petstore_auth

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]