|
| 1 | +# scala-akka-petstore-client |
| 2 | + |
| 3 | +OpenAPI Petstore |
| 4 | +- API version: 1.0.0 |
| 5 | + |
| 6 | +This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. |
| 7 | + |
| 8 | + |
| 9 | +*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* |
| 10 | + |
| 11 | +## Requirements |
| 12 | + |
| 13 | +Building the API client library requires: |
| 14 | +1. Java 1.7+ |
| 15 | +2. Maven/Gradle/SBT |
| 16 | + |
| 17 | +## Installation |
| 18 | + |
| 19 | +To install the API client library to your local Maven repository, simply execute: |
| 20 | + |
| 21 | +```shell |
| 22 | +mvn clean install |
| 23 | +``` |
| 24 | + |
| 25 | +To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: |
| 26 | + |
| 27 | +```shell |
| 28 | +mvn clean deploy |
| 29 | +``` |
| 30 | + |
| 31 | +Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. |
| 32 | + |
| 33 | +### Maven users |
| 34 | + |
| 35 | +Add this dependency to your project's POM: |
| 36 | + |
| 37 | +```xml |
| 38 | +<dependency> |
| 39 | + <groupId>org.openapitools</groupId> |
| 40 | + <artifactId>scala-akka-petstore-client</artifactId> |
| 41 | + <version>1.0.0</version> |
| 42 | + <scope>compile</scope> |
| 43 | +</dependency> |
| 44 | +``` |
| 45 | + |
| 46 | +### Gradle users |
| 47 | + |
| 48 | +Add this dependency to your project's build file: |
| 49 | + |
| 50 | +```groovy |
| 51 | +compile "org.openapitools:scala-akka-petstore-client:1.0.0" |
| 52 | +``` |
| 53 | + |
| 54 | +### SBT users |
| 55 | + |
| 56 | +```scala |
| 57 | +libraryDependencies += "org.openapitools" % "scala-akka-petstore-client" % "1.0.0" |
| 58 | +``` |
| 59 | + |
| 60 | +## Getting Started |
| 61 | + |
| 62 | +## Documentation for API Endpoints |
| 63 | + |
| 64 | +All URIs are relative to *http://petstore.swagger.io/v2* |
| 65 | + |
| 66 | +Class | Method | HTTP request | Description |
| 67 | +------------ | ------------- | ------------- | ------------- |
| 68 | +*PetApi* | **addPet** | **POST** /pet | Add a new pet to the store |
| 69 | +*PetApi* | **deletePet** | **DELETE** /pet/{petId} | Deletes a pet |
| 70 | +*PetApi* | **findPetsByStatus** | **GET** /pet/findByStatus | Finds Pets by status |
| 71 | +*PetApi* | **findPetsByTags** | **GET** /pet/findByTags | Finds Pets by tags |
| 72 | +*PetApi* | **getPetById** | **GET** /pet/{petId} | Find pet by ID |
| 73 | +*PetApi* | **updatePet** | **PUT** /pet | Update an existing pet |
| 74 | +*PetApi* | **updatePetWithForm** | **POST** /pet/{petId} | Updates a pet in the store with form data |
| 75 | +*PetApi* | **uploadFile** | **POST** /pet/{petId}/uploadImage | uploads an image |
| 76 | +*StoreApi* | **deleteOrder** | **DELETE** /store/order/{orderId} | Delete purchase order by ID |
| 77 | +*StoreApi* | **getInventory** | **GET** /store/inventory | Returns pet inventories by status |
| 78 | +*StoreApi* | **getOrderById** | **GET** /store/order/{orderId} | Find purchase order by ID |
| 79 | +*StoreApi* | **placeOrder** | **POST** /store/order | Place an order for a pet |
| 80 | +*UserApi* | **createUser** | **POST** /user | Create user |
| 81 | +*UserApi* | **createUsersWithArrayInput** | **POST** /user/createWithArray | Creates list of users with given input array |
| 82 | +*UserApi* | **createUsersWithListInput** | **POST** /user/createWithList | Creates list of users with given input array |
| 83 | +*UserApi* | **deleteUser** | **DELETE** /user/{username} | Delete user |
| 84 | +*UserApi* | **getUserByName** | **GET** /user/{username} | Get user by user name |
| 85 | +*UserApi* | **loginUser** | **GET** /user/login | Logs user into the system |
| 86 | +*UserApi* | **logoutUser** | **GET** /user/logout | Logs out current logged in user session |
| 87 | +*UserApi* | **updateUser** | **PUT** /user/{username} | Updated user |
| 88 | + |
| 89 | + |
| 90 | +## Documentation for Models |
| 91 | + |
| 92 | + - [ApiResponse](ApiResponse.md) |
| 93 | + - [Category](Category.md) |
| 94 | + - [InlineObject](InlineObject.md) |
| 95 | + - [InlineObject1](InlineObject1.md) |
| 96 | + - [Order](Order.md) |
| 97 | + - [Pet](Pet.md) |
| 98 | + - [Tag](Tag.md) |
| 99 | + - [User](User.md) |
| 100 | + |
| 101 | + |
| 102 | +## Documentation for Authorization |
| 103 | + |
| 104 | +Authentication schemes defined for the API: |
| 105 | +### api_key |
| 106 | + |
| 107 | +- **Type**: API key |
| 108 | +- **API key parameter name**: api_key |
| 109 | +- **Location**: HTTP header |
| 110 | + |
| 111 | +### auth_cookie |
| 112 | + |
| 113 | +- **Type**: API key |
| 114 | +- **API key parameter name**: AUTH_KEY |
| 115 | +- **Location**: |
| 116 | + |
| 117 | + |
| 118 | +## Author |
| 119 | + |
| 120 | + |
| 121 | + |
0 commit comments