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

[Go] fix documentation of API authorization in README files (#15345)

Browse Source 
align wording across generators
This commit is contained in:
Tiffany Marrel 2023-05-09 08:24:16 +02:00 committed by GitHub
parent adfb963831
commit 4deaad557e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 5 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
modules/openapi-generator/src/main/resources/go/README.mustache vendored
View File

@ -98,10 +98,9 @@ Class | Method | HTTP request | Description
## 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}} {{#isApiKey}}

5
samples/client/petstore/go/go-petstore/README.md
View File

@ -172,7 +172,7 @@ Class | Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
Authentication schemes defined for the API:
### petstore_auth ### petstore_auth
@ -202,7 +202,6 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args) r, err := client.Service.Operation(auth, args)
``` ```
### api_key ### api_key
- **Type**: API key - **Type**: API key
@ -211,7 +210,6 @@ r, err := client.Service.Operation(auth, args)
Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key and passed in as the auth context for each request. Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key and passed in as the auth context for each request.
### api_key_query ### api_key_query
- **Type**: API key - **Type**: API key
@ -220,7 +218,6 @@ Note, each API key must be added to a map of `map[string]APIKey` where the key i
Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key_query and passed in as the auth context for each request. Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key_query and passed in as the auth context for each request.
### http_basic_test ### http_basic_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication

3
samples/openapi3/client/extensions/x-auth-id-alias/go-experimental/README.md
View File

@ -90,7 +90,7 @@ Class | Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
Authentication schemes defined for the API:
### api_key ### api_key
- **Type**: API key - **Type**: API key
@ -99,7 +99,6 @@ Class | Method | HTTP request | Description
Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-Api-Key and passed in as the auth context for each request. Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-Api-Key and passed in as the auth context for each request.
### api_key_query ### api_key_query
- **Type**: API key - **Type**: API key

7
samples/openapi3/client/petstore/go/go-petstore/README.md
View File

@ -192,7 +192,7 @@ Class | Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
Authentication schemes defined for the API:
### petstore_auth ### petstore_auth
@ -222,7 +222,6 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args) r, err := client.Service.Operation(auth, args)
``` ```
### api_key ### api_key
- **Type**: API key - **Type**: API key
@ -231,7 +230,6 @@ r, err := client.Service.Operation(auth, args)
Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key and passed in as the auth context for each request. Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key and passed in as the auth context for each request.
### api_key_query ### api_key_query
- **Type**: API key - **Type**: API key
@ -240,7 +238,6 @@ Note, each API key must be added to a map of `map[string]APIKey` where the key i
Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key_query and passed in as the auth context for each request. Note, each API key must be added to a map of `map[string]APIKey` where the key is: api_key_query and passed in as the auth context for each request.
### http_basic_test ### http_basic_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication
@ -255,7 +252,6 @@ auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAut
r, err := client.Service.Operation(auth, args) r, err := client.Service.Operation(auth, args)
``` ```
### bearer_test ### bearer_test
- **Type**: HTTP Bearer token authentication - **Type**: HTTP Bearer token authentication
@ -267,7 +263,6 @@ auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_T
r, err := client.Service.Operation(auth, args) r, err := client.Service.Operation(auth, args)
``` ```
### http_signature_test ### http_signature_test
- **Type**: HTTP signature authentication - **Type**: HTTP signature authentication