[Java] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators
OpenAPITools · May 9, 2023 · 2226847 · 2226847
1 parent ef35e6d
commit 2226847
Show file tree

Hide file tree

Showing 37 changed files with 204 additions and 24 deletions.
diff --git a/modules/openapi-generator/src/main/resources/Java/README.mustache b/modules/openapi-generator/src/main/resources/Java/README.mustache
@@ -197,11 +197,14 @@ Class | Method | HTTP request | Description
 {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
 {{/model}}{{/models}}
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
-{{^authMethods}}All endpoints do not require authorization.
-{{/authMethods}}Authentication schemes defined for the API:
-{{#authMethods}}### {{name}}
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a name="{{name}}"></a>
+### {{name}}
 
 {{#isApiKey}}
 

diff --git a/...les/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache b/...les/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache
@@ -158,11 +158,14 @@ Class | Method | HTTP request | Description
 {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
 {{/model}}{{/models}}
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
-{{^authMethods}}All endpoints do not require authorization.
-{{/authMethods}}Authentication schemes defined for the API:
-{{#authMethods}}### {{name}}
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a name="{{name}}"></a>
+### {{name}}
 
 {{#isApiKey}}
 

diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache
@@ -139,11 +139,14 @@ Class | Method | HTTP request | Description
 {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
 {{/model}}{{/models}}
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
-{{^authMethods}}All endpoints do not require authorization.
-{{/authMethods}}Authentication schemes defined for the API:
-{{#authMethods}}### {{name}}
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a name="{{name}}"></a>
+### {{name}}
 
 {{#isApiKey}}
 

diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache
@@ -155,11 +155,14 @@ Class | Method | HTTP request | Description
 {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
 {{/model}}{{/models}}
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
-{{^authMethods}}All endpoints do not require authorization.
-{{/authMethods}}Authentication schemes defined for the API:
-{{#authMethods}}### {{name}}
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a name="{{name}}"></a>
+### {{name}}
 
 {{#isApiKey}}- **Type**: API key
 - **API key parameter name**: {{keyParamName}}

diff --git a/samples/client/echo_api/java/apache-httpclient/README.md b/samples/client/echo_api/java/apache-httpclient/README.md
@@ -140,10 +140,11 @@ Class | Method | HTTP request | Description
  - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
 
 
+<a name="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
 

diff --git a/samples/client/echo_api/java/native/README.md b/samples/client/echo_api/java/native/README.md
@@ -156,10 +156,11 @@ Class | Method | HTTP request | Description
  - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
 
 
+<a name="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
 

diff --git a/samples/client/echo_api/java/okhttp-gson/README.md b/samples/client/echo_api/java/okhttp-gson/README.md
@@ -147,10 +147,11 @@ Class | Method | HTTP request | Description
  - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
 
 
+<a name="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
 

diff --git a/samples/client/others/java/okhttp-gson-streaming/README.md b/samples/client/others/java/okhttp-gson-streaming/README.md
@@ -127,10 +127,11 @@ Class | Method | HTTP request | Description
  - [SomeObj](docs/SomeObj.md)
 
 
+<a name="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
 

diff --git a/samples/client/petstore/java/apache-httpclient/README.md b/samples/client/petstore/java/apache-httpclient/README.md
@@ -201,9 +201,12 @@ Class | Method | HTTP request | Description
  - [User](docs/User.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -214,30 +217,35 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 
 - **Type**: HTTP basic authentication
 
+<a name="bearer_test"></a>
 ### bearer_test
 
 
 - **Type**: HTTP basic authentication
 
+<a name="http_signature_test"></a>
 ### http_signature_test
 
 

diff --git a/samples/client/petstore/java/google-api-client/README.md b/samples/client/petstore/java/google-api-client/README.md
@@ -204,9 +204,12 @@ Class | Method | HTTP request | Description
  - [XmlItem](docs/XmlItem.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -217,20 +220,23 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 

diff --git a/samples/client/petstore/java/jersey1/README.md b/samples/client/petstore/java/jersey1/README.md
@@ -204,9 +204,12 @@ Class | Method | HTTP request | Description
  - [XmlItem](docs/XmlItem.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -217,20 +220,23 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 

diff --git a/samples/client/petstore/java/jersey2-java8-localdatetime/README.md b/samples/client/petstore/java/jersey2-java8-localdatetime/README.md
@@ -229,9 +229,12 @@ Class | Method | HTTP request | Description
  - [XmlItem](docs/XmlItem.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -242,20 +245,23 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 

diff --git a/samples/client/petstore/java/jersey2-java8/README.md b/samples/client/petstore/java/jersey2-java8/README.md
@@ -229,9 +229,12 @@ Class | Method | HTTP request | Description
  - [XmlItem](docs/XmlItem.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -242,20 +245,23 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 

diff --git a/samples/client/petstore/java/jersey3/README.md b/samples/client/petstore/java/jersey3/README.md
@@ -234,9 +234,12 @@ Class | Method | HTTP request | Description
  - [Zebra](docs/Zebra.md)
 
 
+<a name="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a name="petstore_auth"></a>
 ### petstore_auth
 
 
@@ -247,30 +250,35 @@ Authentication schemes defined for the API:
   - write:pets: modify pets in your account
   - read:pets: read your pets
 
+<a name="api_key"></a>
 ### api_key
 
 
 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header
 
+<a name="api_key_query"></a>
 ### api_key_query
 
 
 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string
 
+<a name="http_basic_test"></a>
 ### http_basic_test
 
 
 - **Type**: HTTP basic authentication
 
+<a name="bearer_test"></a>
 ### bearer_test
 
 
 - **Type**: HTTP basic authentication
 
+<a name="http_signature_test"></a>
 ### http_signature_test