|
| 1 | +# io.swagger.client - Kotlin client library for Swagger Petstore |
| 2 | + |
| 3 | +## Requires |
| 4 | + |
| 5 | +* Kotlin 1.1.2 |
| 6 | +* Gradle 3.3 |
| 7 | + |
| 8 | +## Build |
| 9 | + |
| 10 | +First, create the gradle wrapper script: |
| 11 | + |
| 12 | +``` |
| 13 | +gradle wrapper |
| 14 | +``` |
| 15 | + |
| 16 | +Then, run: |
| 17 | + |
| 18 | +``` |
| 19 | +./gradlew check assemble |
| 20 | +``` |
| 21 | + |
| 22 | +This runs all tests and packages the library. |
| 23 | + |
| 24 | +## Features/Implementation Notes |
| 25 | + |
| 26 | +* Supports JSON inputs/outputs, File inputs, and Form inputs. |
| 27 | +* Supports collection formats for query parameters: csv, tsv, ssv, pipes. |
| 28 | +* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in Swagger definitions. |
| 29 | +* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets. |
| 30 | + |
| 31 | +<a name="documentation-for-api-endpoints"></a> |
| 32 | +## Documentation for API Endpoints |
| 33 | + |
| 34 | +All URIs are relative to */* |
| 35 | + |
| 36 | +Class | Method | HTTP request | Description |
| 37 | +------------ | ------------- | ------------- | ------------- |
| 38 | +*DefaultApi* | [**testMethod**](docs/DefaultApi.md#testmethod) | **GET** /test | |
| 39 | +*PetApi* | [**addParrot**](docs/PetApi.md#addparrot) | **POST** /parrot | Add a new parrow to the store |
| 40 | +*PetApi* | [**addPet**](docs/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store |
| 41 | +*PetApi* | [**deletePet**](docs/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet |
| 42 | +*PetApi* | [**feedPet**](docs/PetApi.md#feedpet) | **POST** /pet/feed/{petId} | Find pet by ID |
| 43 | +*PetApi* | [**findPetsByStatus**](docs/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status |
| 44 | +*PetApi* | [**findPetsByTags**](docs/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags |
| 45 | +*PetApi* | [**getParrots**](docs/PetApi.md#getparrots) | **GET** /parrot | get Parrots |
| 46 | +*PetApi* | [**getPetById**](docs/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID |
| 47 | +*PetApi* | [**updateParrots**](docs/PetApi.md#updateparrots) | **PUT** /parrot | update parrots |
| 48 | +*PetApi* | [**updatePet**](docs/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet |
| 49 | +*PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data |
| 50 | +*PetApi* | [**uploadFile**](docs/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
| 51 | +*StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID |
| 52 | +*StoreApi* | [**getInventory**](docs/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status |
| 53 | +*StoreApi* | [**getOrderById**](docs/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID |
| 54 | +*StoreApi* | [**placeOrder**](docs/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
| 55 | +*UserApi* | [**createUser**](docs/UserApi.md#createuser) | **POST** /user | Create user |
| 56 | +*UserApi* | [**createUsersWithArrayInput**](docs/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array |
| 57 | +*UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array |
| 58 | +*UserApi* | [**deleteUser**](docs/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user |
| 59 | +*UserApi* | [**getUserByName**](docs/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name |
| 60 | +*UserApi* | [**loginUser**](docs/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system |
| 61 | +*UserApi* | [**logoutUser**](docs/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
| 62 | +*UserApi* | [**userUsernamePut**](docs/UserApi.md#userusernameput) | **PUT** /user/{username} | Updated user |
| 63 | + |
| 64 | +<a name="documentation-for-models"></a> |
| 65 | +## Documentation for Models |
| 66 | + |
| 67 | + - [io.swagger.client.models.AllPetsResponse](docs/AllPetsResponse.md) |
| 68 | + - [io.swagger.client.models.AnyOfbody2](docs/AnyOfbody2.md) |
| 69 | + - [io.swagger.client.models.ApiResponse](docs/ApiResponse.md) |
| 70 | + - [io.swagger.client.models.Body](docs/Body.md) |
| 71 | + - [io.swagger.client.models.Body1](docs/Body1.md) |
| 72 | + - [io.swagger.client.models.Body2](docs/Body2.md) |
| 73 | + - [io.swagger.client.models.Cat](docs/Cat.md) |
| 74 | + - [io.swagger.client.models.Category](docs/Category.md) |
| 75 | + - [io.swagger.client.models.Dog](docs/Dog.md) |
| 76 | + - [io.swagger.client.models.InlineResponse200](docs/InlineResponse200.md) |
| 77 | + - [io.swagger.client.models.InlineResponse2001](docs/InlineResponse2001.md) |
| 78 | + - [io.swagger.client.models.Macaw](docs/Macaw.md) |
| 79 | + - [io.swagger.client.models.OneOfAllPetsResponseItems](docs/OneOfAllPetsResponseItems.md) |
| 80 | + - [io.swagger.client.models.OneOfPartMasterOrigin](docs/OneOfPartMasterOrigin.md) |
| 81 | + - [io.swagger.client.models.OneOfPup](docs/OneOfPup.md) |
| 82 | + - [io.swagger.client.models.OneOfinlineResponse2001](docs/OneOfinlineResponse2001.md) |
| 83 | + - [io.swagger.client.models.Order](docs/Order.md) |
| 84 | + - [io.swagger.client.models.Parakeet](docs/Parakeet.md) |
| 85 | + - [io.swagger.client.models.PartFour](docs/PartFour.md) |
| 86 | + - [io.swagger.client.models.PartMaster](docs/PartMaster.md) |
| 87 | + - [io.swagger.client.models.PartOne](docs/PartOne.md) |
| 88 | + - [io.swagger.client.models.PartThree](docs/PartThree.md) |
| 89 | + - [io.swagger.client.models.PartTwo](docs/PartTwo.md) |
| 90 | + - [io.swagger.client.models.Pet](docs/Pet.md) |
| 91 | + - [io.swagger.client.models.Pup](docs/Pup.md) |
| 92 | + - [io.swagger.client.models.Tag](docs/Tag.md) |
| 93 | + - [io.swagger.client.models.Test](docs/Test.md) |
| 94 | + - [io.swagger.client.models.User](docs/User.md) |
| 95 | + - [io.swagger.client.models.ValMemberChoice1](docs/ValMemberChoice1.md) |
| 96 | + - [io.swagger.client.models.ValMemberChoice2](docs/ValMemberChoice2.md) |
| 97 | + - [io.swagger.client.models.ValMembers](docs/ValMembers.md) |
| 98 | + |
| 99 | +<a name="documentation-for-authorization"></a> |
| 100 | +## Documentation for Authorization |
| 101 | + |
| 102 | +<a name="api_key"></a> |
| 103 | +### api_key |
| 104 | + |
| 105 | + |
| 106 | +<a name="bearer"></a> |
| 107 | +### bearer |
| 108 | + |
| 109 | + |
| 110 | +<a name="petstore_auth"></a> |
| 111 | +### petstore_auth |
| 112 | + |
| 113 | +- **Type**: OAuth |
| 114 | +- **Flow**: implicit |
| 115 | +- **Authorization URL**: http://petstore.swagger.io/oauth/dialog |
| 116 | +- **Scopes**: |
| 117 | + - : |
| 118 | + |
0 commit comments