class

Build::Configuration

Inherits Reference < Object

Constructors

new

Create a new Configuration.

Source
new

Create a new Configuration with block.

config = Petstore::Configuration.new do |config|
  config.username = "xxx"
  config.password = "xxx"
end
Source

Class methods

default

The default Configuration object.

Source

Instance methods

access_token

Defines the access token (Bearer) used with OAuth2.

Source
access_token=(access_token : String | Nil)

Defines the access token (Bearer) used with OAuth2.

Source
api_key

Defines API keys used with API Key authentications.

@return [Hash] key: parameter name, value: parameter value (API key)

@example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string) config.api_key[:api_key] = "xxx"

Source
api_key=(api_key : Hash(Symbol, String))

Defines API keys used with API Key authentications.

@return [Hash] key: parameter name, value: parameter value (API key)

@example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string) config.api_key[:api_key] = "xxx"

Source
api_key_prefix

Defines API key prefixes used with API Key authentications.

@return [Hash] key: parameter name, value: API key prefix

@example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers) config.api_key_prefix[:api_key] = "Token"

Source
api_key_prefix=(api_key_prefix : Hash(Symbol, String))

Defines API key prefixes used with API Key authentications.

@return [Hash] key: parameter name, value: API key prefix

@example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers) config.api_key_prefix[:api_key] = "Token"

Source
api_key_with_prefix(param_name)

Gets API key (with prefix if set). @param [String] param_name the parameter name of API key auth

Source
auth_settings

Returns Auth Settings hash for api client.

Source
base_path

Defines url base path

Source
base_path=(base_path : String)

Defines url base path

Source
base_path=(base_path)
Source
base_url(operation = Nil)

Returns base URL for specified operation based on server settings

Source
basic_auth_token

Gets Basic Auth token string

Source
client_side_validation

Set this to false to skip client side validation in the operation. Default to true. @return [true, false]

Source
client_side_validation=(client_side_validation : Bool)

Set this to false to skip client side validation in the operation. Default to true. @return [true, false]

Source
configure

Configure object with block.

Source
debugging

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with logger.debug (see the logger attribute). Default to false.

@return [true, false]

Source
debugging=(debugging : Bool)

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with logger.debug (see the logger attribute). Default to false.

@return [true, false]

Source
host

Defines url host

Source
host=(host : String)

Defines url host

Source
host=(host)
Source
operation_server_settings
Source
password

Defines the password used with HTTP basic authentication.

@return [String]

Source
password=(password : String | Nil)

Defines the password used with HTTP basic authentication.

@return [String]

Source
scheme

Defines url scheme

Source
scheme=(scheme : String)

Defines url scheme

Source
scheme=(scheme)
Source
server_index

Define server configuration index

Source
server_index=(server_index : Int32)

Define server configuration index

Source
server_operation_index

Define server operation configuration index

Source
server_operation_index=(server_operation_index : Hash(Symbol, String))

Define server operation configuration index

Source
server_operation_variables

Default server operation variables

Source
server_operation_variables=(server_operation_variables : Hash(Symbol, String))

Default server operation variables

Source
server_settings

Returns an array of Server setting

Source
server_url(index, variables = {} of Symbol => String, servers = Nil)

Returns URL based on server settings

@param index array index of the server settings @param variables hash of variable and the corresponding value

Source
server_variables

Default server variables

Source
server_variables=(server_variables : Hash(Symbol, String))

Default server variables

Source
temp_folder_path

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use Tempfile.

@return [String]

Source
temp_folder_path=(temp_folder_path : String | Nil)

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use Tempfile.

@return [String]

Source
timeout

The time limit for HTTP request in seconds. Default to 0 (never times out).

Source
timeout=(timeout : Int32)

The time limit for HTTP request in seconds. Default to 0 (never times out).

Source
username

Defines the username used with HTTP basic authentication.

@return [String]

Source
username=(username : String | Nil)

Defines the username used with HTTP basic authentication.

@return [String]

Source