loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-04 18:46:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

[kotlin] cleanup documentation (#15307)

Browse Source 
* [kotlin] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators

* [kotlin] fix anchor links in documentation

---------

Co-authored-by: Tiffany Marrel <tiffany.marrel@flowable.com>
This commit is contained in:
Tiffany Marrel
2023-04-27 12:33:15 +02:00
committed by GitHub
parent e211e1451d
commit da96058f5b
174 changed files with 756 additions and 728 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
samples/client/petstore/kotlin-json-request-string/README.md
View File

@@ -37,7 +37,7 @@ This runs all tests and packages the library.
* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.
<a name="documentation-for-api-endpoints"></a>
<a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints
All URIs are relative to *http://petstore.swagger.io/v2*
@@ -66,7 +66,7 @@ Class | Method | HTTP request | Description
*UserApi* | [**updateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
<a name="documentation-for-models"></a>
<a id="documentation-for-models"></a>
## Documentation for Models
- [org.openapitools.client.models.Category](docs/Category.md)
@@ -77,10 +77,12 @@ Class | Method | HTTP request | Description
- [org.openapitools.client.models.User](docs/User.md)
<a name="documentation-for-authorization"></a>
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
<a name="petstore_auth"></a>
Authentication schemes defined for the API:
<a id="petstore_auth"></a>
### petstore_auth
- **Type**: OAuth
@@ -90,7 +92,7 @@ Class | Method | HTTP request | Description
- write:pets: modify pets in your account
- read:pets: read your pets
<a name="api_key"></a>
<a id="api_key"></a>
### api_key
- **Type**: API key

2
samples/client/petstore/kotlin-json-request-string/docs/Order.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**complete** | **kotlin.Boolean** | | [optional]
<a name="Status"></a>
<a id="Status"></a>
## Enum: status
Name | Value
---- | -----

2
samples/client/petstore/kotlin-json-request-string/docs/Pet.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**status** | [**inline**](#Status) | pet status in the store | [optional]
<a name="Status"></a>
<a id="Status"></a>
## Enum: status
Name | Value
---- | -----

16
samples/client/petstore/kotlin-json-request-string/docs/PetApi.md
View File

@@ -14,7 +14,7 @@ Method | HTTP request | Description
[**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
<a name="addPet"></a>
<a id="addPet"></a>
# **addPet**
> addPet(body)
@@ -60,7 +60,7 @@ Configure petstore_auth:
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deletePet"></a>
<a id="deletePet"></a>
# **deletePet**
> deletePet(petId, apiKey)
@@ -108,7 +108,7 @@ Configure petstore_auth:
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="findPetsByTags"></a>
<a id="findPetsByTags"></a>
# **findPetsByTags**
> kotlin.collections.List&lt;Pet&gt; findPetsByTags(tags)
@@ -157,7 +157,7 @@ Configure petstore_auth:
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getAllPets"></a>
<a id="getAllPets"></a>
# **getAllPets**
> kotlin.collections.List&lt;Pet&gt; getAllPets(lastUpdated)
@@ -204,7 +204,7 @@ Configure petstore_auth:
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getPetById"></a>
<a id="getPetById"></a>
# **getPetById**
> Pet getPetById(petId)
@@ -254,7 +254,7 @@ Configure api_key:
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updatePet"></a>
<a id="updatePet"></a>
# **updatePet**
> updatePet(body)
@@ -300,7 +300,7 @@ Configure petstore_auth:
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="updatePetWithForm"></a>
<a id="updatePetWithForm"></a>
# **updatePetWithForm**
> updatePetWithForm(petId, name, status)
@@ -350,7 +350,7 @@ Configure petstore_auth:
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
<a name="uploadFile"></a>
<a id="uploadFile"></a>
# **uploadFile**
> ModelApiResponse uploadFile(petId, additionalMetadata, file)

8
samples/client/petstore/kotlin-json-request-string/docs/StoreApi.md
View File

@@ -10,7 +10,7 @@ Method | HTTP request | Description
[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
<a name="deleteOrder"></a>
<a id="deleteOrder"></a>
# **deleteOrder**
> deleteOrder(orderId)
@@ -56,7 +56,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getInventory"></a>
<a id="getInventory"></a>
# **getInventory**
> kotlin.collections.Map&lt;kotlin.String, kotlin.Int&gt; getInventory()
@@ -102,7 +102,7 @@ Configure api_key:
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getOrderById"></a>
<a id="getOrderById"></a>
# **getOrderById**
> Order getOrderById(orderId)
@@ -149,7 +149,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="placeOrder"></a>
<a id="placeOrder"></a>
# **placeOrder**
> Order placeOrder(body)

16
samples/client/petstore/kotlin-json-request-string/docs/UserApi.md
View File

@@ -14,7 +14,7 @@ Method | HTTP request | Description
[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
<a name="createUser"></a>
<a id="createUser"></a>
# **createUser**
> createUser(body)
@@ -60,7 +60,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="createUsersWithArrayInput"></a>
<a id="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
@@ -104,7 +104,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="createUsersWithListInput"></a>
<a id="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
@@ -148,7 +148,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="deleteUser"></a>
<a id="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
@@ -194,7 +194,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getUserByName"></a>
<a id="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
@@ -239,7 +239,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="loginUser"></a>
<a id="loginUser"></a>
# **loginUser**
> kotlin.String loginUser(username, password)
@@ -286,7 +286,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="logoutUser"></a>
<a id="logoutUser"></a>
# **logoutUser**
> logoutUser()
@@ -326,7 +326,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="updateUser"></a>
<a id="updateUser"></a>
# **updateUser**
> updateUser(username, body)