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

2
samples/client/petstore/java/okhttp-gson/docs/AnotherFakeApi.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags |
<a name="call123testSpecialTags"></a>
<a id="call123testSpecialTags"></a>
# **call123testSpecialTags**
> Client call123testSpecialTags(client)

2
samples/client/petstore/java/okhttp-gson/docs/DefaultApi.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**fooGet**](DefaultApi.md#fooGet) | **GET** /foo | |
<a name="fooGet"></a>
<a id="fooGet"></a>
# **fooGet**
> FooGetDefaultResponse fooGet()

30
samples/client/petstore/java/okhttp-gson/docs/FakeApi.md
View File

@@ -21,7 +21,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**testQueryParameterCollectionFormat**](FakeApi.md#testQueryParameterCollectionFormat) | **PUT** /fake/test-query-parameters | |
<a name="fakeHealthGet"></a>
<a id="fakeHealthGet"></a>
# **fakeHealthGet**
> HealthCheckResult fakeHealthGet()
@@ -77,7 +77,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | The instance started successfully | - |
<a name="fakeOuterBooleanSerialize"></a>
<a id="fakeOuterBooleanSerialize"></a>
# **fakeOuterBooleanSerialize**
> Boolean fakeOuterBooleanSerialize(body)
@@ -139,7 +139,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Output boolean | - |
<a name="fakeOuterCompositeSerialize"></a>
<a id="fakeOuterCompositeSerialize"></a>
# **fakeOuterCompositeSerialize**
> OuterComposite fakeOuterCompositeSerialize(outerComposite)
@@ -201,7 +201,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Output composite | - |
<a name="fakeOuterNumberSerialize"></a>
<a id="fakeOuterNumberSerialize"></a>
# **fakeOuterNumberSerialize**
> BigDecimal fakeOuterNumberSerialize(body)
@@ -263,7 +263,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Output number | - |
<a name="fakeOuterStringSerialize"></a>
<a id="fakeOuterStringSerialize"></a>
# **fakeOuterStringSerialize**
> String fakeOuterStringSerialize(body)
@@ -325,7 +325,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Output string | - |
<a name="getArrayOfEnums"></a>
<a id="getArrayOfEnums"></a>
# **getArrayOfEnums**
> List&lt;OuterEnum&gt; getArrayOfEnums()
@@ -381,7 +381,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Got named array of enums | - |
<a name="testBodyWithFileSchema"></a>
<a id="testBodyWithFileSchema"></a>
# **testBodyWithFileSchema**
> testBodyWithFileSchema(fileSchemaTestClass)
@@ -442,7 +442,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Success | - |
<a name="testBodyWithQueryParams"></a>
<a id="testBodyWithQueryParams"></a>
# **testBodyWithQueryParams**
> testBodyWithQueryParams(query, user)
@@ -503,7 +503,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Success | - |
<a name="testClientModel"></a>
<a id="testClientModel"></a>
# **testClientModel**
> Client testClientModel(client)
@@ -565,7 +565,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | successful operation | - |
<a name="testEndpointParameters"></a>
<a id="testEndpointParameters"></a>
# **testEndpointParameters**
> testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)
@@ -659,7 +659,7 @@ null (empty response body)
| **400** | Invalid username supplied | - |
| **404** | User not found | - |
<a name="testEnumParameters"></a>
<a id="testEnumParameters"></a>
# **testEnumParameters**
> testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString)
@@ -735,7 +735,7 @@ No authorization required
| **400** | Invalid request | - |
| **404** | Not found | - |
<a name="testGroupParameters"></a>
<a id="testGroupParameters"></a>
# **testGroupParameters**
> testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group).stringGroup(stringGroup).booleanGroup(booleanGroup).int64Group(int64Group).execute();
@@ -815,7 +815,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **400** | Something wrong | - |
<a name="testInlineAdditionalProperties"></a>
<a id="testInlineAdditionalProperties"></a>
# **testInlineAdditionalProperties**
> testInlineAdditionalProperties(requestBody)
@@ -876,7 +876,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | successful operation | - |
<a name="testJsonFormData"></a>
<a id="testJsonFormData"></a>
# **testJsonFormData**
> testJsonFormData(param, param2)
@@ -939,7 +939,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | successful operation | - |
<a name="testQueryParameterCollectionFormat"></a>
<a id="testQueryParameterCollectionFormat"></a>
# **testQueryParameterCollectionFormat**
> testQueryParameterCollectionFormat(pipe, ioutil, http, url, context)

2
samples/client/petstore/java/okhttp-gson/docs/FakeClassnameTags123Api.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case |
<a name="testClassname"></a>
<a id="testClassname"></a>
# **testClassname**
> Client testClassname(client)

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

@@ -15,7 +15,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
<a name="addPet"></a>
<a id="addPet"></a>
# **addPet**
> addPet(pet)
@@ -82,7 +82,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **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)
@@ -219,7 +219,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)
@@ -288,7 +288,7 @@ public class Example {
| **200** | successful operation | - |
| **400** | Invalid tag value | - |
<a name="getPetById"></a>
<a id="getPetById"></a>
# **getPetById**
> Pet getPetById(petId)
@@ -359,7 +359,7 @@ public class Example {
| **400** | Invalid ID supplied | - |
| **404** | Pet not found | - |
<a name="updatePet"></a>
<a id="updatePet"></a>
# **updatePet**
> updatePet(pet)
@@ -428,7 +428,7 @@ null (empty response body)
| **404** | Pet not found | - |
| **405** | Validation exception | - |
<a name="updatePetWithForm"></a>
<a id="updatePetWithForm"></a>
# **updatePetWithForm**
> updatePetWithForm(petId, name, status)
@@ -498,7 +498,7 @@ null (empty response body)
|-------------|-------------|------------------|
| **405** | Invalid input | - |
<a name="uploadFile"></a>
<a id="uploadFile"></a>
# **uploadFile**
> ModelApiResponse uploadFile(petId, additionalMetadata, _file)
@@ -569,7 +569,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | successful operation | - |
<a name="uploadFileWithRequiredFile"></a>
<a id="uploadFileWithRequiredFile"></a>
# **uploadFileWithRequiredFile**
> ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata)

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

@@ -10,7 +10,7 @@ All URIs are relative to *http://petstore.swagger.io:80/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/docs/UserApi.md
View File

@@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
| [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user |
<a name="createUser"></a>
<a id="createUser"></a>
# **createUser**
> createUser(user)
@@ -75,7 +75,7 @@ No authorization required
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="createUsersWithArrayInput"></a>
<a id="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(user)
@@ -136,7 +136,7 @@ No authorization required
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="createUsersWithListInput"></a>
<a id="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(user)
@@ -197,7 +197,7 @@ No authorization required
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="deleteUser"></a>
<a id="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
@@ -259,7 +259,7 @@ No authorization required
| **400** | Invalid username supplied | - |
| **404** | User not found | - |
<a name="getUserByName"></a>
<a id="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
@@ -323,7 +323,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)
@@ -388,7 +388,7 @@ No authorization required
| **200** | successful operation | * 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()
@@ -445,7 +445,7 @@ No authorization required
|-------------|-------------|------------------|
| **0** | successful operation | - |
<a name="updateUser"></a>
<a id="updateUser"></a>
# **updateUser**
> updateUser(username, user)