|
| 1 | +# Rust API client for petstore-reqwest |
| 2 | + |
| 3 | +This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. |
| 4 | + |
| 5 | + |
| 6 | +## Overview |
| 7 | + |
| 8 | +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. |
| 9 | + |
| 10 | +- API version: 1.0.0 |
| 11 | +- Package version: 1.0.0 |
| 12 | +- Generator version: 7.18.0-SNAPSHOT |
| 13 | +- Build package: `org.openapitools.codegen.languages.RustClientCodegen` |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +Put the package under your project folder in a directory named `petstore-reqwest` and add the following to `Cargo.toml` under `[dependencies]`: |
| 18 | + |
| 19 | +``` |
| 20 | +petstore-reqwest = { path = "./petstore-reqwest" } |
| 21 | +``` |
| 22 | + |
| 23 | +## Documentation for API Endpoints |
| 24 | + |
| 25 | +All URIs are relative to *http://localhost/v2* |
| 26 | + |
| 27 | +Class | Method | HTTP request | Description |
| 28 | +------------ | ------------- | ------------- | ------------- |
| 29 | +*FakeApi* | [**test_nullable_required_param**](docs/FakeApi.md#test_nullable_required_param) | **GET** /fake/user/{user_name} | To test nullable required parameters |
| 30 | +*PetApi* | [**add_pet**](docs/PetApi.md#add_pet) | **POST** /pet | Add a new pet to the store |
| 31 | +*PetApi* | [**delete_pet**](docs/PetApi.md#delete_pet) | **DELETE** /pet/{petId} | Deletes a pet |
| 32 | +*PetApi* | [**find_pets_by_status**](docs/PetApi.md#find_pets_by_status) | **GET** /pet/findByStatus | Finds Pets by status |
| 33 | +*PetApi* | [**find_pets_by_tags**](docs/PetApi.md#find_pets_by_tags) | **GET** /pet/findByTags | Finds Pets by tags |
| 34 | +*PetApi* | [**get_pet_by_id**](docs/PetApi.md#get_pet_by_id) | **GET** /pet/{petId} | Find pet by ID |
| 35 | +*PetApi* | [**pets_explode_post**](docs/PetApi.md#pets_explode_post) | **POST** /pets/explode | List all pets |
| 36 | +*PetApi* | [**pets_post**](docs/PetApi.md#pets_post) | **POST** /pets | List all pets |
| 37 | +*PetApi* | [**update_pet**](docs/PetApi.md#update_pet) | **PUT** /pet | Update an existing pet |
| 38 | +*PetApi* | [**update_pet_with_form**](docs/PetApi.md#update_pet_with_form) | **POST** /pet/{petId} | Updates a pet in the store with form data |
| 39 | +*PetApi* | [**upload_file**](docs/PetApi.md#upload_file) | **POST** /pet/{petId}/uploadImage | uploads an image |
| 40 | +*StoreApi* | [**delete_order**](docs/StoreApi.md#delete_order) | **DELETE** /store/order/{orderId} | Delete purchase order by ID |
| 41 | +*StoreApi* | [**get_inventory**](docs/StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status |
| 42 | +*StoreApi* | [**get_order_by_id**](docs/StoreApi.md#get_order_by_id) | **GET** /store/order/{orderId} | Find purchase order by ID |
| 43 | +*StoreApi* | [**place_order**](docs/StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet |
| 44 | +*TestingApi* | [**tests_all_of_with_one_model_get**](docs/TestingApi.md#tests_all_of_with_one_model_get) | **GET** /tests/allOfWithOneModel | Test for allOf with a single option. (One of the issues in #20500) |
| 45 | +*TestingApi* | [**tests_file_response_get**](docs/TestingApi.md#tests_file_response_get) | **GET** /tests/fileResponse | Returns an image file |
| 46 | +*TestingApi* | [**tests_type_testing_get**](docs/TestingApi.md#tests_type_testing_get) | **GET** /tests/typeTesting | Route to test the TypeTesting schema |
| 47 | +*UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create user |
| 48 | +*UserApi* | [**create_users_with_array_input**](docs/UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array |
| 49 | +*UserApi* | [**create_users_with_list_input**](docs/UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array |
| 50 | +*UserApi* | [**delete_user**](docs/UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user |
| 51 | +*UserApi* | [**get_user_by_name**](docs/UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name |
| 52 | +*UserApi* | [**login_user**](docs/UserApi.md#login_user) | **GET** /user/login | Logs user into the system |
| 53 | +*UserApi* | [**logout_user**](docs/UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session |
| 54 | +*UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/{username} | Updated user |
| 55 | + |
| 56 | + |
| 57 | +## Documentation For Models |
| 58 | + |
| 59 | + - [ActionContainer](docs/ActionContainer.md) |
| 60 | + - [AnyTypeTest](docs/AnyTypeTest.md) |
| 61 | + - [ApiResponse](docs/ApiResponse.md) |
| 62 | + - [ArrayItemRefTest](docs/ArrayItemRefTest.md) |
| 63 | + - [Baz](docs/Baz.md) |
| 64 | + - [Category](docs/Category.md) |
| 65 | + - [EnumArrayTesting](docs/EnumArrayTesting.md) |
| 66 | + - [NullableArray](docs/NullableArray.md) |
| 67 | + - [NumericEnumTesting](docs/NumericEnumTesting.md) |
| 68 | + - [OptionalTesting](docs/OptionalTesting.md) |
| 69 | + - [Order](docs/Order.md) |
| 70 | + - [Page](docs/Page.md) |
| 71 | + - [Person](docs/Person.md) |
| 72 | + - [Pet](docs/Pet.md) |
| 73 | + - [PropertyTest](docs/PropertyTest.md) |
| 74 | + - [Ref](docs/Ref.md) |
| 75 | + - [Return](docs/Return.md) |
| 76 | + - [Tag](docs/Tag.md) |
| 77 | + - [TestAllOfWithMultiMetadataOnly](docs/TestAllOfWithMultiMetadataOnly.md) |
| 78 | + - [TypeTesting](docs/TypeTesting.md) |
| 79 | + - [UniqueItemArrayTesting](docs/UniqueItemArrayTesting.md) |
| 80 | + - [User](docs/User.md) |
| 81 | + - [Vehicle](docs/Vehicle.md) |
| 82 | + - [WithInnerOneOf](docs/WithInnerOneOf.md) |
| 83 | + |
| 84 | + |
| 85 | +To get access to the crate's generated documentation, use: |
| 86 | + |
| 87 | +``` |
| 88 | +cargo doc --open |
| 89 | +``` |
| 90 | + |
| 91 | +## Author |
| 92 | + |
| 93 | + |
| 94 | + |
0 commit comments