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/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)