loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-11 16:52:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Java] Cleanup documentation (#15300)

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

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

* [Java] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel
2023-05-10 08:14:44 +02:00
committed by GitHub
parent f9937e77d6
commit 8a6c708884
99 changed files with 527 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
samples/client/petstore/java-micronaut-client/docs/apis/AnotherFakeApi.md
View File

@@ -35,7 +35,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="call123testSpecialTags"></a>
<a id="call123testSpecialTags"></a>
# **call123testSpecialTags**
```java
Mono<ModelClient> AnotherFakeApi.call123testSpecialTags(_body)

28
samples/client/petstore/java-micronaut-client/docs/apis/FakeApi.md
View File

@@ -48,7 +48,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="createXmlItem"></a>
<a id="createXmlItem"></a>
# **createXmlItem**
```java
Mono<Void> FakeApi.createXmlItem(xmlItem)
@@ -72,7 +72,7 @@ this route creates an XmlItem
- **Content-Type**: `application/xml`, `application/xml; charset=utf-8`, `application/xml; charset=utf-16`, `text/xml`, `text/xml; charset=utf-8`, `text/xml; charset=utf-16`
- **Accept**: Not defined
<a name="fakeOuterBooleanSerialize"></a>
<a id="fakeOuterBooleanSerialize"></a>
# **fakeOuterBooleanSerialize**
```java
Mono<Boolean> FakeApi.fakeOuterBooleanSerialize(_body)
@@ -97,7 +97,7 @@ Test serialization of outer boolean types
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="fakeOuterCompositeSerialize"></a>
<a id="fakeOuterCompositeSerialize"></a>
# **fakeOuterCompositeSerialize**
```java
Mono<OuterComposite> FakeApi.fakeOuterCompositeSerialize(_body)
@@ -122,7 +122,7 @@ Test serialization of object with outer number type
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="fakeOuterNumberSerialize"></a>
<a id="fakeOuterNumberSerialize"></a>
# **fakeOuterNumberSerialize**
```java
Mono<BigDecimal> FakeApi.fakeOuterNumberSerialize(_body)
@@ -147,7 +147,7 @@ Test serialization of outer number types
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="fakeOuterStringSerialize"></a>
<a id="fakeOuterStringSerialize"></a>
# **fakeOuterStringSerialize**
```java
Mono<String> FakeApi.fakeOuterStringSerialize(_body)
@@ -172,7 +172,7 @@ Test serialization of outer string types
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="testBodyWithFileSchema"></a>
<a id="testBodyWithFileSchema"></a>
# **testBodyWithFileSchema**
```java
Mono<Void> FakeApi.testBodyWithFileSchema(_body)
@@ -196,7 +196,7 @@ For this test, the body for this request much reference a schema named &#x60;Fil
- **Content-Type**: `application/json`
- **Accept**: Not defined
<a name="testBodyWithQueryParams"></a>
<a id="testBodyWithQueryParams"></a>
# **testBodyWithQueryParams**
```java
Mono<Void> FakeApi.testBodyWithQueryParams(query_body)
@@ -219,7 +219,7 @@ Mono<Void> FakeApi.testBodyWithQueryParams(query_body)
- **Content-Type**: `application/json`
- **Accept**: Not defined
<a name="testClientModel"></a>
<a id="testClientModel"></a>
# **testClientModel**
```java
Mono<ModelClient> FakeApi.testClientModel(_body)
@@ -244,7 +244,7 @@ To test \&quot;client\&quot; model
- **Content-Type**: `application/json`
- **Accept**: `application/json`
<a name="testEndpointParameters"></a>
<a id="testEndpointParameters"></a>
# **testEndpointParameters**
```java
Mono<Void> FakeApi.testEndpointParameters(number_doublepatternWithoutDelimiter_byteintegerint32int64_floatstringbinarydatedateTimepasswordparamCallback)
@@ -282,7 +282,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイ
- **Content-Type**: `application/x-www-form-urlencoded`
- **Accept**: Not defined
<a name="testEnumParameters"></a>
<a id="testEnumParameters"></a>
# **testEnumParameters**
```java
Mono<Void> FakeApi.testEnumParameters(enumHeaderStringArrayenumHeaderStringenumQueryStringArrayenumQueryStringenumQueryIntegerenumQueryDoubleenumFormStringArrayenumFormString)
@@ -313,7 +313,7 @@ To test enum parameters
- **Content-Type**: `application/x-www-form-urlencoded`
- **Accept**: Not defined
<a name="testGroupParameters"></a>
<a id="testGroupParameters"></a>
# **testGroupParameters**
```java
Mono<Void> FakeApi.testGroupParameters(requiredStringGrouprequiredBooleanGrouprequiredInt64GroupstringGroupbooleanGroupint64Group)
@@ -342,7 +342,7 @@ Fake endpoint to test group parameters (optional)
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="testInlineAdditionalProperties"></a>
<a id="testInlineAdditionalProperties"></a>
# **testInlineAdditionalProperties**
```java
Mono<Void> FakeApi.testInlineAdditionalProperties(param)
@@ -364,7 +364,7 @@ test inline additionalProperties
- **Content-Type**: `application/json`
- **Accept**: Not defined
<a name="testJsonFormData"></a>
<a id="testJsonFormData"></a>
# **testJsonFormData**
```java
Mono<Void> FakeApi.testJsonFormData(paramparam2)
@@ -387,7 +387,7 @@ test json serialization of form data
- **Content-Type**: `application/x-www-form-urlencoded`
- **Accept**: Not defined
<a name="testQueryParameterCollectionFormat"></a>
<a id="testQueryParameterCollectionFormat"></a>
# **testQueryParameterCollectionFormat**
```java
Mono<Void> FakeApi.testQueryParameterCollectionFormat(pipeioutilhttpurlcontext)

2
samples/client/petstore/java-micronaut-client/docs/apis/FakeClassnameTags123Api.md
View File

@@ -35,7 +35,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="testClassname"></a>
<a id="testClassname"></a>
# **testClassname**
```java
Mono<ModelClient> FakeClassnameTags123Api.testClassname(_body)

18
samples/client/petstore/java-micronaut-client/docs/apis/PetApi.md
View File

@@ -43,7 +43,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="addPet"></a>
<a id="addPet"></a>
# **addPet**
```java
Mono<Void> PetApi.addPet(_body)
@@ -66,7 +66,7 @@ Add a new pet to the store
- **Content-Type**: `application/json`, `application/xml`
- **Accept**: Not defined
<a name="deletePet"></a>
<a id="deletePet"></a>
# **deletePet**
```java
Mono<Void> PetApi.deletePet(petIdapiKey)
@@ -90,7 +90,7 @@ Deletes a pet
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="findPetsByStatus"></a>
<a id="findPetsByStatus"></a>
# **findPetsByStatus**
```java
Mono<List<Pet>> PetApi.findPetsByStatus(status)
@@ -116,7 +116,7 @@ Multiple status values can be provided with comma separated strings
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="findPetsByTags"></a>
<a id="findPetsByTags"></a>
# **findPetsByTags**
```java
Mono<Set<Pet>> PetApi.findPetsByTags(tags)
@@ -142,7 +142,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="getPetById"></a>
<a id="getPetById"></a>
# **getPetById**
```java
Mono<Pet> PetApi.getPetById(petId)
@@ -168,7 +168,7 @@ Returns a single pet
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="updatePet"></a>
<a id="updatePet"></a>
# **updatePet**
```java
Mono<Void> PetApi.updatePet(_body)
@@ -191,7 +191,7 @@ Update an existing pet
- **Content-Type**: `application/json`, `application/xml`
- **Accept**: Not defined
<a name="updatePetWithForm"></a>
<a id="updatePetWithForm"></a>
# **updatePetWithForm**
```java
Mono<Void> PetApi.updatePetWithForm(petIdnamestatus)
@@ -216,7 +216,7 @@ Updates a pet in the store with form data
- **Content-Type**: `application/x-www-form-urlencoded`
- **Accept**: Not defined
<a name="uploadFile"></a>
<a id="uploadFile"></a>
# **uploadFile**
```java
Mono<ModelApiResponse> PetApi.uploadFile(petIdadditionalMetadata_file)
@@ -242,7 +242,7 @@ uploads an image
- **Content-Type**: `multipart/form-data`
- **Accept**: `application/json`
<a name="uploadFileWithRequiredFile"></a>
<a id="uploadFileWithRequiredFile"></a>
# **uploadFileWithRequiredFile**
```java
Mono<ModelApiResponse> PetApi.uploadFileWithRequiredFile(petIdrequiredFileadditionalMetadata)

8
samples/client/petstore/java-micronaut-client/docs/apis/StoreApi.md
View File

@@ -38,7 +38,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="deleteOrder"></a>
<a id="deleteOrder"></a>
# **deleteOrder**
```java
Mono<Void> StoreApi.deleteOrder(orderId)
@@ -62,7 +62,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getInventory"></a>
<a id="getInventory"></a>
# **getInventory**
```java
Mono<Map<String, Integer>> StoreApi.getInventory()
@@ -84,7 +84,7 @@ Returns a map of status codes to quantities
- **Content-Type**: Not defined
- **Accept**: `application/json`
<a name="getOrderById"></a>
<a id="getOrderById"></a>
# **getOrderById**
```java
Mono<Order> StoreApi.getOrderById(orderId)
@@ -109,7 +109,7 @@ For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other val
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="placeOrder"></a>
<a id="placeOrder"></a>
# **placeOrder**
```java
Mono<Order> StoreApi.placeOrder(_body)

16
samples/client/petstore/java-micronaut-client/docs/apis/UserApi.md
View File

@@ -42,7 +42,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat
More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).
<a name="createUser"></a>
<a id="createUser"></a>
# **createUser**
```java
Mono<Void> UserApi.createUser(_body)
@@ -66,7 +66,7 @@ This can only be done by the logged in user.
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="createUsersWithArrayInput"></a>
<a id="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
```java
Mono<Void> UserApi.createUsersWithArrayInput(_body)
@@ -88,7 +88,7 @@ Creates list of users with given input array
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="createUsersWithListInput"></a>
<a id="createUsersWithListInput"></a>
# **createUsersWithListInput**
```java
Mono<Void> UserApi.createUsersWithListInput(_body)
@@ -110,7 +110,7 @@ Creates list of users with given input array
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="deleteUser"></a>
<a id="deleteUser"></a>
# **deleteUser**
```java
Mono<Void> UserApi.deleteUser(username)
@@ -134,7 +134,7 @@ This can only be done by the logged in user.
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getUserByName"></a>
<a id="getUserByName"></a>
# **getUserByName**
```java
Mono<User> UserApi.getUserByName(username)
@@ -157,7 +157,7 @@ Get user by user name
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="loginUser"></a>
<a id="loginUser"></a>
# **loginUser**
```java
Mono<String> UserApi.loginUser(usernamepassword)
@@ -181,7 +181,7 @@ Logs user into the system
- **Content-Type**: Not defined
- **Accept**: `application/xml`, `application/json`
<a name="logoutUser"></a>
<a id="logoutUser"></a>
# **logoutUser**
```java
Mono<Void> UserApi.logoutUser()
@@ -199,7 +199,7 @@ Logs out current logged in user session
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="updateUser"></a>
<a id="updateUser"></a>
# **updateUser**
```java
Mono<Void> UserApi.updateUser(username_body)

8
samples/client/petstore/java-micronaut-client/docs/apis/auth.md
View File

@@ -1,5 +1,5 @@
# Authorization methods
<a name="name"></a>
<a id="name"></a>
# petstore_auth
Authorization method is **OAuth2** with `implicit` flow.
The scopes are:
@@ -9,17 +9,17 @@ The scopes are:
It can be configured in the [application.yml](src/main/resources/application.yml) using Micronaut security features.
More information on configuring can be found in [Micronaut Security Guide](https://micronaut-projects.github.io/micronaut-security/latest/guide/#oauth).
<a name="name"></a>
<a id="name"></a>
# api_key
Authorization method is of **api key type**. The parameter `api_key` is located in `header`.
It can be configured in the [application.yml](src/main/resources/application.yml) using Micronaut security features.
<a name="name"></a>
<a id="name"></a>
# api_key_query
Authorization method is of **api key type**. The parameter `api_key_query` is located in `query`.
It can be configured in the [application.yml](src/main/resources/application.yml) using Micronaut security features.
<a name="name"></a>
<a id="name"></a>
# http_basic_test
Authorization method is of **basic auth**.