loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[Scala] cleanup documentation (#15304)

Browse Source 
* [Scala] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators

* [Scala] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel 2023-05-09 08:30:28 +02:00 committed by GitHub
parent 1443dd9493
commit 76fd2a2f66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
modules/openapi-generator/src/main/resources/scala-akka-client/README.mustache vendored
View File

@ -136,11 +136,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}} {{/model}}{{/models}}
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
{{^authMethods}}All endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}Authentication schemes defined for the API: {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}}### {{name}} {{#authMethods}}
<a id="{{name}}"></a>
### {{name}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
- **API key parameter name**: {{keyParamName}} - **API key parameter name**: {{keyParamName}}

9
modules/openapi-generator/src/main/resources/scala-httpclient/README.mustache vendored
View File

@ -81,11 +81,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}} {{/model}}{{/models}}
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
{{^authMethods}}All endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}Authentication schemes defined for the API: {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}}### {{name}} {{#authMethods}}
<a id="{{name}}"></a>
### {{name}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
- **API key parameter name**: {{keyParamName}} - **API key parameter name**: {{keyParamName}}

9
modules/openapi-generator/src/main/resources/scala-sttp/README.mustache vendored
View File

@ -79,11 +79,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}} {{/model}}{{/models}}
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
{{^authMethods}}All endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}Authentication schemes defined for the API: {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}}### {{name}} {{#authMethods}}
<a id="{{name}}"></a>
### {{name}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
- **API key parameter name**: {{keyParamName}} - **API key parameter name**: {{keyParamName}}

4
samples/client/petstore/scala-akka/README.md
View File

@ -144,15 +144,19 @@ Class | Method | HTTP request | Description
- [User](docs/User.md) - [User](docs/User.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
Authentication schemes defined for the API: Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key ### api_key
- **Type**: API key - **Type**: API key
- **API key parameter name**: api_key - **API key parameter name**: api_key
- **Location**: HTTP header - **Location**: HTTP header
<a id="auth_cookie"></a>
### auth_cookie ### auth_cookie
- **Type**: API key - **Type**: API key

3
samples/client/petstore/scala-sttp/README.md
View File

@ -98,9 +98,12 @@ Class | Method | HTTP request | Description
- [User](User.md) - [User](User.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
Authentication schemes defined for the API: Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key ### api_key
- **Type**: API key - **Type**: API key