[swift5] cleanup documentation (#15351)

* [swift5] fix documentation of API authorization in README files fix hierarchy level + add internal links + align wording across generators * [swift5] fix anchor links in documentation --------- Co-authored-by: Tiffany Marrel <tiffany.marrel@flowable.com>
2023-04-30 10:11:45 +02:00
parent ab819b9b18
commit 5f8c4ec640
19 changed files with 160 additions and 65 deletions
--- a/modules/openapi-generator/src/main/resources/swift5/README.mustache
+++ b/modules/openapi-generator/src/main/resources/swift5/README.mustache
@@ -48,11 +48,14 @@ Class | Method | HTTP request | Description
 {{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
 {{/model}}{{/models}}

+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization

-{{^authMethods}} All endpoints do not require authorization.
-{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
-{{#authMethods}}## {{{name}}}
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a id="{{name}}"></a>
+### {{name}}

 {{#isApiKey}}- **Type**: API key
 - **API key parameter name**: {{{keyParamName}}}
--- a/samples/client/petstore/swift5/alamofireLibrary/README.md
+++ b/samples/client/petstore/swift5/alamofireLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/anycodable/README.md
+++ b/samples/client/petstore/swift5/anycodable/README.md
@@ -34,9 +34,10 @@ Class | Method | HTTP request | Description
 - [PrefixPetSuffix](docs/PrefixPetSuffix.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization

- All endpoints do not require authorization.
+Endpoints do not require authorization.


 ## Author
--- a/samples/client/petstore/swift5/asyncAwaitLibrary/README.md
+++ b/samples/client/petstore/swift5/asyncAwaitLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/combineLibrary/README.md
+++ b/samples/client/petstore/swift5/combineLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/default/README.md
+++ b/samples/client/petstore/swift5/default/README.md
@@ -118,10 +118,13 @@ Class | Method | HTTP request | Description
 - [XmlItem](docs/XmlItem.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -130,19 +133,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/deprecated/README.md
+++ b/samples/client/petstore/swift5/deprecated/README.md
@@ -57,10 +57,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -69,13 +72,15 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## auth_cookie
+<a id="auth_cookie"></a>
+### auth_cookie

 - **Type**: API key
 - **API key parameter name**: AUTH_KEY
--- a/samples/client/petstore/swift5/frozenEnums/README.md
+++ b/samples/client/petstore/swift5/frozenEnums/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/nonPublicApi/README.md
+++ b/samples/client/petstore/swift5/nonPublicApi/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/objcCompatible/README.md
+++ b/samples/client/petstore/swift5/objcCompatible/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/oneOf/README.md
+++ b/samples/client/petstore/swift5/oneOf/README.md
@@ -35,9 +35,10 @@ Class | Method | HTTP request | Description
 - [Fruit](docs/Fruit.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization

- All endpoints do not require authorization.
+Endpoints do not require authorization.


 ## Author
--- a/samples/client/petstore/swift5/promisekitLibrary/README.md
+++ b/samples/client/petstore/swift5/promisekitLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/readonlyProperties/README.md
+++ b/samples/client/petstore/swift5/readonlyProperties/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/resultLibrary/README.md
+++ b/samples/client/petstore/swift5/resultLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/rxswiftLibrary/README.md
+++ b/samples/client/petstore/swift5/rxswiftLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/urlsessionLibrary/README.md
+++ b/samples/client/petstore/swift5/urlsessionLibrary/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/validation/README.md
+++ b/samples/client/petstore/swift5/validation/README.md
@@ -33,9 +33,10 @@ Class | Method | HTTP request | Description
 - [Banana](docs/Banana.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization

- All endpoints do not require authorization.
+Endpoints do not require authorization.


 ## Author
--- a/samples/client/petstore/swift5/vaporLibrary/README.md
+++ b/samples/client/petstore/swift5/vaporLibrary/README.md
@@ -114,10 +114,13 @@ Class | Method | HTTP request | Description
 - [XmlItem](docs/XmlItem.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -126,19 +129,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication

--- a/samples/client/petstore/swift5/x-swift-hashable/README.md
+++ b/samples/client/petstore/swift5/x-swift-hashable/README.md
@@ -106,10 +106,13 @@ Class | Method | HTTP request | Description
 - [User](docs/User.md)


+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization


-## petstore_auth
+Authentication schemes defined for the API:
+<a id="petstore_auth"></a>
+### petstore_auth

 - **Type**: OAuth
 - **Flow**: implicit
@@ -118,19 +121,22 @@ Class | Method | HTTP request | Description
 - **write:pets**: modify pets in your account
 - **read:pets**: read your pets

-## api_key
+<a id="api_key"></a>
+### api_key

 - **Type**: API key
 - **API key parameter name**: api_key
 - **Location**: HTTP header

-## api_key_query
+<a id="api_key_query"></a>
+### api_key_query

 - **Type**: API key
 - **API key parameter name**: api_key_query
 - **Location**: URL query string

-## http_basic_test
+<a id="http_basic_test"></a>
+### http_basic_test

 - **Type**: HTTP basic authentication