forked from loafle/openapi-generator-original
[rust] fix documentation of API authorization in README files (#15352)
fix hierarchy level + align wording across generators
This commit is contained in:
parent
76fd2a2f66
commit
ef35e6d7ea
@ -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
|
||||||
|
@ -110,7 +110,7 @@ Method | HTTP request | Description
|
|||||||
|
|
||||||
|
|
||||||
## Documentation For Authorization
|
## Documentation For Authorization
|
||||||
Endpoints do not require authorization.
|
Endpoints do not require authorization.
|
||||||
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
@ -103,7 +103,7 @@ Method | HTTP request | Description
|
|||||||
|
|
||||||
|
|
||||||
## Documentation For Authorization
|
## Documentation For Authorization
|
||||||
Endpoints do not require authorization.
|
Endpoints do not require authorization.
|
||||||
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
@ -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
|
||||||
|
@ -175,7 +175,7 @@ Method | HTTP request | Description
|
|||||||
|
|
||||||
|
|
||||||
## Documentation For Authorization
|
## Documentation For Authorization
|
||||||
Endpoints do not require authorization.
|
Endpoints do not require authorization.
|
||||||
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
@ -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
|
||||||
|
@ -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
|
||||||
|
@ -125,7 +125,7 @@ Method | HTTP request | Description
|
|||||||
|
|
||||||
|
|
||||||
## Documentation For Authorization
|
## Documentation For Authorization
|
||||||
Endpoints do not require authorization.
|
Endpoints do not require authorization.
|
||||||
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
Loading…
x
Reference in New Issue
Block a user