forked from loafle/openapi-generator-original
60ceded171
* Ensure CLI-level generator settings are available in additional properties * Initial conversion to yaml configs Configs prefix with 1- need to be manually evaluated. * Add "other" configs not in ensure-up-to-date * Add other/openapi3 files * Cleanup all generation scripts * Clean up: add missed configs and fix some openapi 3 diffs * Move generate-samples script, error on batch failures * Temporarily disable elm which requires skip validation of spec * CI updates (todo: run all generators through appveyor or move to github workflows) * Add success count to batch generation command output * [samples] Regenerate * Remove bin/windows * Generate swift5 samples in bitrise * Expand user input glob pattern * Regenerate samples * Update PR template * Support config based generateAliasAsModel * [samples] Regenerate * [rust] Generate as alias for all samples configs * [csharp] Move test staged file changes to in-directory * Include "live" test files and ignore test cache files from samples.ci * Remove concept of samples.ci staging Generators support .openapi-generator-ignore, allowing maintainers to explicitly ignore the regeneration of files which have been modified. Note that the tooling does not overwrite test files whenever those files exist, and it's not entirely necessary to add test files to the ignore file. * Re-add meta generator scripts * Modify ensure-up-to-date to log stdout, so script does not look like it hangs on slower machines * [csharp] Regenerate sample * Set generateAliasAsModel CodegenConfigurator#toContext This ensures the property (which is effectively a thread-local) gets set as expected if the caller resets GlobalSettings as is done in the GenerateBatch command. * [rust] Regenerate samples * Re-enable elm * [java] Support OffsetDateTime example, fail ensures script on any generation error * [samples] Regenerate * Fix jersey2-java8 ignore file * Fix elm spec validation * Force UTC in sample generation to avoid timezone conflicts during generation (user vs ci) Co-authored-by: William Cheng <wing328hk@gmail.com>
116 lines
3.5 KiB
Markdown
116 lines
3.5 KiB
Markdown
# scala-sttp-petstore
|
|
|
|
OpenAPI Petstore
|
|
- API version: 1.0.0
|
|
|
|
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
|
|
|
|
|
|
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
|
|
|
|
## Requirements
|
|
|
|
Building the API client library requires:
|
|
1. Java 1.7+
|
|
2. Maven/Gradle/SBT
|
|
|
|
## Installation
|
|
|
|
To install the API client library to your local Maven repository, simply execute:
|
|
|
|
```shell
|
|
mvn clean install
|
|
```
|
|
|
|
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
|
|
|
|
```shell
|
|
mvn clean deploy
|
|
```
|
|
|
|
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
|
|
|
|
### Maven users
|
|
|
|
Add this dependency to your project's POM:
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>org.openapitools</groupId>
|
|
<artifactId>scala-sttp-petstore</artifactId>
|
|
<version>1.0.0</version>
|
|
<scope>compile</scope>
|
|
</dependency>
|
|
```
|
|
|
|
### Gradle users
|
|
|
|
Add this dependency to your project's build file:
|
|
|
|
```groovy
|
|
compile "org.openapitools:scala-sttp-petstore:1.0.0"
|
|
```
|
|
|
|
### SBT users
|
|
|
|
```scala
|
|
libraryDependencies += "org.openapitools" % "scala-sttp-petstore" % "1.0.0"
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*PetApi* | **addPet** | **POST** /pet | Add a new pet to the store
|
|
*PetApi* | **deletePet** | **DELETE** /pet/${petId} | Deletes a pet
|
|
*PetApi* | **findPetsByStatus** | **GET** /pet/findByStatus | Finds Pets by status
|
|
*PetApi* | **findPetsByTags** | **GET** /pet/findByTags | Finds Pets by tags
|
|
*PetApi* | **getPetById** | **GET** /pet/${petId} | Find pet by ID
|
|
*PetApi* | **updatePet** | **PUT** /pet | Update an existing pet
|
|
*PetApi* | **updatePetWithForm** | **POST** /pet/${petId} | Updates a pet in the store with form data
|
|
*PetApi* | **uploadFile** | **POST** /pet/${petId}/uploadImage | uploads an image
|
|
*StoreApi* | **deleteOrder** | **DELETE** /store/order/${orderId} | Delete purchase order by ID
|
|
*StoreApi* | **getInventory** | **GET** /store/inventory | Returns pet inventories by status
|
|
*StoreApi* | **getOrderById** | **GET** /store/order/${orderId} | Find purchase order by ID
|
|
*StoreApi* | **placeOrder** | **POST** /store/order | Place an order for a pet
|
|
*UserApi* | **createUser** | **POST** /user | Create user
|
|
*UserApi* | **createUsersWithArrayInput** | **POST** /user/createWithArray | Creates list of users with given input array
|
|
*UserApi* | **createUsersWithListInput** | **POST** /user/createWithList | Creates list of users with given input array
|
|
*UserApi* | **deleteUser** | **DELETE** /user/${username} | Delete user
|
|
*UserApi* | **getUserByName** | **GET** /user/${username} | Get user by user name
|
|
*UserApi* | **loginUser** | **GET** /user/login | Logs user into the system
|
|
*UserApi* | **logoutUser** | **GET** /user/logout | Logs out current logged in user session
|
|
*UserApi* | **updateUser** | **PUT** /user/${username} | Updated user
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [ApiResponse](ApiResponse.md)
|
|
- [Category](Category.md)
|
|
- [InlineObject](InlineObject.md)
|
|
- [InlineObject1](InlineObject1.md)
|
|
- [Order](Order.md)
|
|
- [Pet](Pet.md)
|
|
- [Tag](Tag.md)
|
|
- [User](User.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
Authentication schemes defined for the API:
|
|
### api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key
|
|
- **Location**: HTTP header
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|