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

5
samples/client/echo_api/java/apache-httpclient/README.md
View File

@@ -140,10 +140,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.
## Recommendation

5
samples/client/echo_api/java/native/README.md
View File

@@ -156,10 +156,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.
## Recommendation

5
samples/client/echo_api/java/okhttp-gson/README.md
View File

@@ -147,10 +147,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.
## Recommendation

12
samples/client/echo_api/java/okhttp-gson/docs/BodyApi.md
View File

@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:3000*
| [**testEchoBodyTagResponseString**](BodyApi.md#testEchoBodyTagResponseString) | **POST** /echo/body/Tag/response_string | Test empty json (request body) |
<a name="testBinaryGif"></a>
<a id="testBinaryGif"></a>
# **testBinaryGif**
> File testBinaryGif()
@@ -70,7 +70,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testBodyApplicationOctetstreamBinary"></a>
<a id="testBodyApplicationOctetstreamBinary"></a>
# **testBodyApplicationOctetstreamBinary**
> String testBodyApplicationOctetstreamBinary(body)
@@ -132,7 +132,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testEchoBodyFreeFormObjectResponseString"></a>
<a id="testEchoBodyFreeFormObjectResponseString"></a>
# **testEchoBodyFreeFormObjectResponseString**
> String testEchoBodyFreeFormObjectResponseString(body)
@@ -194,7 +194,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testEchoBodyPet"></a>
<a id="testEchoBodyPet"></a>
# **testEchoBodyPet**
> Pet testEchoBodyPet(pet)
@@ -256,7 +256,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testEchoBodyPetResponseString"></a>
<a id="testEchoBodyPetResponseString"></a>
# **testEchoBodyPetResponseString**
> String testEchoBodyPetResponseString(pet)
@@ -318,7 +318,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testEchoBodyTagResponseString"></a>
<a id="testEchoBodyTagResponseString"></a>
# **testEchoBodyTagResponseString**
> String testEchoBodyTagResponseString(tag)

2
samples/client/echo_api/java/okhttp-gson/docs/FormApi.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testFormIntegerBooleanString**](FormApi.md#testFormIntegerBooleanString) | **POST** /form/integer/boolean/string | Test form parameter(s) |
<a name="testFormIntegerBooleanString"></a>
<a id="testFormIntegerBooleanString"></a>
# **testFormIntegerBooleanString**
> String testFormIntegerBooleanString(integerForm, booleanForm, stringForm)

2
samples/client/echo_api/java/okhttp-gson/docs/HeaderApi.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testHeaderIntegerBooleanString**](HeaderApi.md#testHeaderIntegerBooleanString) | **GET** /header/integer/boolean/string | Test header parameter(s) |
<a name="testHeaderIntegerBooleanString"></a>
<a id="testHeaderIntegerBooleanString"></a>
# **testHeaderIntegerBooleanString**
> String testHeaderIntegerBooleanString(integerHeader, booleanHeader, stringHeader)

2
samples/client/echo_api/java/okhttp-gson/docs/PathApi.md
View File

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testsPathStringPathStringIntegerPathInteger**](PathApi.md#testsPathStringPathStringIntegerPathInteger) | **GET** /path/string/{path_string}/integer/{path_integer} | Test path parameter(s) |
<a name="testsPathStringPathStringIntegerPathInteger"></a>
<a id="testsPathStringPathStringIntegerPathInteger"></a>
# **testsPathStringPathStringIntegerPathInteger**
> String testsPathStringPathStringIntegerPathInteger(pathString, pathInteger)

16
samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md
View File

@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:3000*
| [**testQueryStyleFormExplodeTrueObjectAllOf**](QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) |
<a name="testEnumRefString"></a>
<a id="testEnumRefString"></a>
# **testEnumRefString**
> String testEnumRefString(enumRefStringQuery)
@@ -76,7 +76,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryDatetimeDateString"></a>
<a id="testQueryDatetimeDateString"></a>
# **testQueryDatetimeDateString**
> String testQueryDatetimeDateString(datetimeQuery, dateQuery, stringQuery)
@@ -142,7 +142,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryIntegerBooleanString"></a>
<a id="testQueryIntegerBooleanString"></a>
# **testQueryIntegerBooleanString**
> String testQueryIntegerBooleanString(integerQuery, booleanQuery, stringQuery)
@@ -208,7 +208,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryStyleDeepObjectExplodeTrueObject"></a>
<a id="testQueryStyleDeepObjectExplodeTrueObject"></a>
# **testQueryStyleDeepObjectExplodeTrueObject**
> String testQueryStyleDeepObjectExplodeTrueObject(queryObject)
@@ -270,7 +270,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryStyleDeepObjectExplodeTrueObjectAllOf"></a>
<a id="testQueryStyleDeepObjectExplodeTrueObjectAllOf"></a>
# **testQueryStyleDeepObjectExplodeTrueObjectAllOf**
> String testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject)
@@ -332,7 +332,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryStyleFormExplodeTrueArrayString"></a>
<a id="testQueryStyleFormExplodeTrueArrayString"></a>
# **testQueryStyleFormExplodeTrueArrayString**
> String testQueryStyleFormExplodeTrueArrayString(queryObject)
@@ -394,7 +394,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryStyleFormExplodeTrueObject"></a>
<a id="testQueryStyleFormExplodeTrueObject"></a>
# **testQueryStyleFormExplodeTrueObject**
> String testQueryStyleFormExplodeTrueObject(queryObject)
@@ -456,7 +456,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |
<a name="testQueryStyleFormExplodeTrueObjectAllOf"></a>
<a id="testQueryStyleFormExplodeTrueObjectAllOf"></a>
# **testQueryStyleFormExplodeTrueObjectAllOf**
> String testQueryStyleFormExplodeTrueObjectAllOf(queryObject)