loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests 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

16
samples/server/petstore/java-micronaut-server/docs/controllers/PetController.md
View File

@@ -15,7 +15,7 @@ Method | HTTP request | Description
[**updatePetWithForm**](#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
[**uploadFile**](#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
<a name="addPet"></a>
<a id="addPet"></a>
# **addPet**
```java
Mono<Pet> PetController.addPet(pet)
@@ -40,7 +40,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/json`, `application/xml`
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="deletePet"></a>
<a id="deletePet"></a>
# **deletePet**
```java
Mono<Object> PetController.deletePet(petIdapiKey)
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: Not defined
<a name="findPetsByStatus"></a>
<a id="findPetsByStatus"></a>
# **findPetsByStatus**
```java
Mono<List<Pet>> PetController.findPetsByStatus(status)
@@ -89,7 +89,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="findPetsByTags"></a>
<a id="findPetsByTags"></a>
# **findPetsByTags**
```java
Mono<List<Pet>> PetController.findPetsByTags(tags)
@@ -114,7 +114,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="getPetById"></a>
<a id="getPetById"></a>
# **getPetById**
```java
Mono<Pet> PetController.getPetById(petId)
@@ -139,7 +139,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="updatePet"></a>
<a id="updatePet"></a>
# **updatePet**
```java
Mono<Pet> PetController.updatePet(pet)
@@ -164,7 +164,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/json`, `application/xml`
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="updatePetWithForm"></a>
<a id="updatePetWithForm"></a>
# **updatePetWithForm**
```java
Mono<Object> PetController.updatePetWithForm(petIdnamestatus)
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/x-www-form-urlencoded`
- **Produces Content-Type**: Not defined
<a name="uploadFile"></a>
<a id="uploadFile"></a>
# **uploadFile**
```java
Mono<ModelApiResponse> PetController.uploadFile(petIdadditionalMetadata_file)

8
samples/server/petstore/java-micronaut-server/docs/controllers/StoreController.md
View File

@@ -11,7 +11,7 @@ Method | HTTP request | Description
[**getOrderById**](#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
[**placeOrder**](#placeOrder) | **POST** /store/order | Place an order for a pet
<a name="deleteOrder"></a>
<a id="deleteOrder"></a>
# **deleteOrder**
```java
Mono<Object> StoreController.deleteOrder(orderId)
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: Not defined
<a name="getInventory"></a>
<a id="getInventory"></a>
# **getInventory**
```java
Mono<Map<String, Integer>> StoreController.getInventory()
@@ -53,7 +53,7 @@ Returns a map of status codes to quantities
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/json`
<a name="getOrderById"></a>
<a id="getOrderById"></a>
# **getOrderById**
```java
Mono<Order> StoreController.getOrderById(orderId)
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="placeOrder"></a>
<a id="placeOrder"></a>
# **placeOrder**
```java
Mono<Order> StoreController.placeOrder(order)

16
samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md
View File

@@ -15,7 +15,7 @@ Method | HTTP request | Description
[**logoutUser**](#logoutUser) | **GET** /user/logout | Logs out current logged in user session
[**updateUser**](#updateUser) | **PUT** /user/{username} | Updated user
<a name="createUser"></a>
<a id="createUser"></a>
# **createUser**
```java
Mono<Object> UserController.createUser(user)
@@ -38,7 +38,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/json`
- **Produces Content-Type**: Not defined
<a name="createUsersWithArrayInput"></a>
<a id="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
```java
Mono<Object> UserController.createUsersWithArrayInput(user)
@@ -61,7 +61,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/json`
- **Produces Content-Type**: Not defined
<a name="createUsersWithListInput"></a>
<a id="createUsersWithListInput"></a>
# **createUsersWithListInput**
```java
Mono<Object> UserController.createUsersWithListInput(user)
@@ -84,7 +84,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: `application/json`
- **Produces Content-Type**: Not defined
<a name="deleteUser"></a>
<a id="deleteUser"></a>
# **deleteUser**
```java
Mono<Object> UserController.deleteUser(username)
@@ -107,7 +107,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: Not defined
<a name="getUserByName"></a>
<a id="getUserByName"></a>
# **getUserByName**
```java
Mono<User> UserController.getUserByName(username)
@@ -130,7 +130,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="loginUser"></a>
<a id="loginUser"></a>
# **loginUser**
```java
Mono<String> UserController.loginUser(usernamepassword)
@@ -154,7 +154,7 @@ Name | Type | Description | Notes
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: `application/xml`, `application/json`
<a name="logoutUser"></a>
<a id="logoutUser"></a>
# **logoutUser**
```java
Mono<Object> UserController.logoutUser()
@@ -173,7 +173,7 @@ Logs out current logged in user session
- **Accepts Content-Type**: Not defined
- **Produces Content-Type**: Not defined
<a name="updateUser"></a>
<a id="updateUser"></a>
# **updateUser**
```java
Mono<Object> UserController.updateUser(usernameuser)