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

fix_ruby_documentation_apikey_name (#19742)

Browse Source
This commit is contained in:
Maxime Vincent 2024-10-01 16:10:54 +02:00 committed by GitHub
parent 2544fa2928
commit c6eb9e0e09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/openapi-generator/src/main/resources/ruby-client/README.mustache vendored
View File

@ -75,9 +75,9 @@ require '{{{gemName}}}'
# Configure a proc to get access tokens in lieu of the static access_token configuration # Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}} config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
# Configure API key authorization: {{{name}}} # Configure API key authorization: {{{name}}}
config.api_key['{{{name}}}'] = 'YOUR API KEY' config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
# Configure OAuth2 access token for authorization: {{{name}}} # Configure OAuth2 access token for authorization: {{{name}}}
config.access_token = 'YOUR ACCESS TOKEN' config.access_token = 'YOUR ACCESS TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration # Configure a proc to get access tokens in lieu of the static access_token configuration

4
modules/openapi-generator/src/main/resources/ruby-client/api_doc.mustache vendored
View File

@ -37,9 +37,9 @@ require '{{{gemName}}}'
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}} # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}} config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
# Configure API key authorization: {{{name}}} # Configure API key authorization: {{{name}}}
config.api_key['{{{name}}}'] = 'YOUR API KEY' config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
# Configure OAuth2 access token for authorization: {{{name}}} # Configure OAuth2 access token for authorization: {{{name}}}
config.access_token = 'YOUR ACCESS TOKEN'{{/isOAuth}} config.access_token = 'YOUR ACCESS TOKEN'{{/isOAuth}}
{{/authMethods}}end {{/authMethods}}end

10
samples/openapi3/client/extensions/x-auth-id-alias/ruby-client/README.md
View File

@ -60,14 +60,14 @@ require 'x_auth_id_alias'
# Setup authorization # Setup authorization
XAuthIDAlias.configure do |config| XAuthIDAlias.configure do |config|
# Configure API key authorization: api_key # Configure API key authorization: api_key
config.api_key['X-Api-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key'] = 'YOUR API KEY' config.api_key['api_key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key'] = 'Bearer' # config.api_key_prefix['api_key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key_query'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key_query'] = 'Bearer'
end end
api_instance = XAuthIDAlias::UsageApi.new api_instance = XAuthIDAlias::UsageApi.new

28
samples/openapi3/client/extensions/x-auth-id-alias/ruby-client/docs/UsageApi.md
View File

@ -26,14 +26,14 @@ require 'x_auth_id_alias'
# setup authorization # setup authorization
XAuthIDAlias.configure do |config| XAuthIDAlias.configure do |config|
# Configure API key authorization: api_key # Configure API key authorization: api_key
config.api_key['X-Api-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key'] = 'YOUR API KEY' config.api_key['api_key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key'] = 'Bearer' # config.api_key_prefix['api_key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key_query'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key_query'] = 'Bearer'
end end
api_instance = XAuthIDAlias::UsageApi.new api_instance = XAuthIDAlias::UsageApi.new
@ -99,14 +99,14 @@ require 'x_auth_id_alias'
# setup authorization # setup authorization
XAuthIDAlias.configure do |config| XAuthIDAlias.configure do |config|
# Configure API key authorization: api_key # Configure API key authorization: api_key
config.api_key['X-Api-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key'] = 'YOUR API KEY' config.api_key['api_key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key'] = 'Bearer' # config.api_key_prefix['api_key'] = 'Bearer'
# Configure API key authorization: api_key_query
config.api_key['api_key_query'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key_query'] = 'Bearer'
end end
api_instance = XAuthIDAlias::UsageApi.new api_instance = XAuthIDAlias::UsageApi.new
@ -172,9 +172,9 @@ require 'x_auth_id_alias'
# setup authorization # setup authorization
XAuthIDAlias.configure do |config| XAuthIDAlias.configure do |config|
# Configure API key authorization: api_key # Configure API key authorization: api_key
config.api_key['api_key'] = 'YOUR API KEY' config.api_key['X-Api-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key'] = 'Bearer' # config.api_key_prefix['X-Api-Key'] = 'Bearer'
end end
api_instance = XAuthIDAlias::UsageApi.new api_instance = XAuthIDAlias::UsageApi.new
@ -240,9 +240,9 @@ require 'x_auth_id_alias'
# setup authorization # setup authorization
XAuthIDAlias.configure do |config| XAuthIDAlias.configure do |config|
# Configure API key authorization: api_key_query # Configure API key authorization: api_key_query
config.api_key['api_key_query'] = 'YOUR API KEY' config.api_key['api_key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_key_query'] = 'Bearer' # config.api_key_prefix['api_key'] = 'Bearer'
end end
api_instance = XAuthIDAlias::UsageApi.new api_instance = XAuthIDAlias::UsageApi.new