loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-03 00:43:46 +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

16
samples/client/petstore/java/okhttp-gson-swagger1/docs/PetApi.md
View File

@@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io/v2*
| [**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image |
<a name="addPet"></a>
<a id="addPet"></a>
# **addPet**
> Pet addPet(pet)
@@ -82,7 +82,7 @@ public class Example {
| **200** | successful operation | - |
| **405** | Invalid input | - |
<a name="deletePet"></a>
<a id="deletePet"></a>
# **deletePet**
> deletePet(petId, apiKey)
@@ -150,7 +150,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **400** | Invalid pet value | - |
<a name="findPetsByStatus"></a>
<a id="findPetsByStatus"></a>
# **findPetsByStatus**
> List&lt;Pet&gt; findPetsByStatus(status)
@@ -218,7 +218,7 @@ public class Example {
| **200** | successful operation | - |
| **400** | Invalid status value | - |
<a name="findPetsByTags"></a>
<a id="findPetsByTags"></a>
# **findPetsByTags**
> List&lt;Pet&gt; findPetsByTags(tags)
@@ -286,7 +286,7 @@ public class Example {
| **200** | successful operation | - |
| **400** | Invalid tag value | - |
<a name="getPetById"></a>
<a id="getPetById"></a>
# **getPetById**
> Pet getPetById(petId)
@@ -357,7 +357,7 @@ public class Example {
| **400** | Invalid ID supplied | - |
| **404** | Pet not found | - |
<a name="updatePet"></a>
<a id="updatePet"></a>
# **updatePet**
> Pet updatePet(pet)
@@ -427,7 +427,7 @@ public class Example {
| **404** | Pet not found | - |
| **405** | Validation exception | - |
<a name="updatePetWithForm"></a>
<a id="updatePetWithForm"></a>
# **updatePetWithForm**
> updatePetWithForm(petId, name, status)
@@ -497,7 +497,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **405** | Invalid input | - |
<a name="uploadFile"></a>
<a id="uploadFile"></a>
# **uploadFile**
> ModelApiResponse uploadFile(petId, additionalMetadata, _file)

8
samples/client/petstore/java/okhttp-gson-swagger1/docs/StoreApi.md
View File

@@ -10,7 +10,7 @@ All URIs are relative to *http://petstore.swagger.io/v2*
| [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet |
<a name="deleteOrder"></a>
<a id="deleteOrder"></a>
# **deleteOrder**
> deleteOrder(orderId)
@@ -72,7 +72,7 @@ No authorization required
| **400** | Invalid ID supplied | - |
| **404** | Order not found | - |
<a name="getInventory"></a>
<a id="getInventory"></a>
# **getInventory**
> Map&lt;String, Integer&gt; getInventory()
@@ -137,7 +137,7 @@ This endpoint does not need any parameter.
|-------------|-------------|------------------|
| **200** | successful operation | - |
<a name="getOrderById"></a>
<a id="getOrderById"></a>
# **getOrderById**
> Order getOrderById(orderId)
@@ -201,7 +201,7 @@ No authorization required
| **400** | Invalid ID supplied | - |
| **404** | Order not found | - |
<a name="placeOrder"></a>
<a id="placeOrder"></a>
# **placeOrder**
> Order placeOrder(order)

16
samples/client/petstore/java/okhttp-gson-swagger1/docs/UserApi.md
View File

@@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io/v2*
| [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user |
<a name="createUser"></a>
<a id="createUser"></a>
# **createUser**
> createUser(user)
@@ -82,7 +82,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="createUsersWithArrayInput"></a>
<a id="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(user)
@@ -150,7 +150,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="createUsersWithListInput"></a>
<a id="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(user)
@@ -218,7 +218,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="deleteUser"></a>
<a id="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
@@ -287,7 +287,7 @@ null (empty response body)
| **400** | Invalid username supplied | - |
| **404** | User not found | - |
<a name="getUserByName"></a>
<a id="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
@@ -351,7 +351,7 @@ No authorization required
| **400** | Invalid username supplied | - |
| **404** | User not found | - |
<a name="loginUser"></a>
<a id="loginUser"></a>
# **loginUser**
> String loginUser(username, password)
@@ -416,7 +416,7 @@ No authorization required
| **200** | successful operation | * Set-Cookie - Cookie authentication key for use with the &#x60;api_key&#x60; apiKey authentication. <br> * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
| **400** | Invalid username/password supplied | - |
<a name="logoutUser"></a>
<a id="logoutUser"></a>
# **logoutUser**
> logoutUser()
@@ -480,7 +480,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="updateUser"></a>
<a id="updateUser"></a>
# **updateUser**
> updateUser(username, user)