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

[rust] fix documentation of API authorization in README files (#15352)

Browse Source 
fix hierarchy level + align wording across generators
This commit is contained in:
Tiffany Marrel 2023-05-09 08:30:54 +02:00 committed by GitHub
parent 76fd2a2f66
commit ef35e6d7ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/openapi-generator/src/main/resources/rust-server/README.mustache vendored
View File

@ -118,10 +118,10 @@ Method | HTTP request | Description
{{/model}}{{/models}} {{/model}}{{/models}}
## Documentation For Authorization ## Documentation For Authorization
{{^authMethods}} Endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}} {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}} {{#authMethods}}
## {{{name}}} ### {{{name}}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
Example Example

3
samples/server/petstore/rust-server/output/openapi-v3/README.md
View File

@ -184,7 +184,8 @@ Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
## authScheme Authentication schemes defined for the API:
### authScheme
- **Type**: OAuth - **Type**: OAuth
- **Flow**: accessCode - **Flow**: accessCode
- **Authorization URL**: http://example.org - **Authorization URL**: http://example.org

9
samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/README.md
View File

@ -202,7 +202,8 @@ Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
## petstore_auth Authentication schemes defined for the API:
### petstore_auth
- **Type**: OAuth - **Type**: OAuth
- **Flow**: implicit - **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
@ -217,19 +218,19 @@ Example
Or via OAuth2 module to automatically refresh tokens and perform user authentication. Or via OAuth2 module to automatically refresh tokens and perform user authentication.
``` ```
``` ```
## api_key ### api_key
- **Type**: API key - **Type**: API key
Example Example
``` ```
``` ```
## api_key_query ### api_key_query
- **Type**: API key - **Type**: API key
Example Example
``` ```
``` ```
## http_basic_test ### http_basic_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication
Example Example

3
samples/server/petstore/rust-server/output/ping-bearer-auth/README.md
View File

@ -104,7 +104,8 @@ Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
## bearerAuth Authentication schemes defined for the API:
### bearerAuth
- **Type**: Bearer token authentication - **Type**: Bearer token authentication
Example Example