module

Octokit::Configurable

Provides configuration options for Client.

Instance methods

access_token

Get access token for authentication.

Source

access_token=(token)

Set access token for authentication.

Source

add_middleware(middleware : Halite::Feature)

Add middleware to the middleware stack.

Source

api_endpoint

API endpoint for Client.

Source

api_endpoint=(val)

Set the api endpoint.

Source

auto_paginate

Do we want to auto paginate.

Source

auto_paginate=(val)

Set if we want to auto paginate.

Source

bearer_token

Get the bearer token.

Source

bearer_token=(token)

Set the bearer token.

Source

client_id

Get the Client ID.

Source

client_id=(val)

Set the Client ID.

Source

client_secret

Get the Client Secret.

Source

client_secret=(val)

Set the Client secret.

Source

configure

Yield a block allowing configuration of options.

Example:

@client.configure do
  auto_paginate = true
end

Source

connection_options

Get the default connection options passed to Halite.

Source

connection_options=(val)

Set the default connection options passed to Halite.

Source

default_media_type

Get the default media type for headers.

Source

default_media_type=(val)

Set the default media type for headers.

Source

logger

Get the configured logger instance.

Source

logger=(val)

Set a configured logger instance.

Source

management_console_endpoint

API endpoint for EnterpriseManagementConsoleClient

Source

management_console_endpoint=(val)

Set the management console password.

Source

middleware

Get the middleware stack for Halite.

Source

middleware=(val)

Set the middleware stack for Halite.

Source

password=(val)

Set the user password.

Source

per_page

Get the maximum results returned per page for paginated endpoints.

Source

per_page=(val)

Set the maximum results returned per page for paginated endpoints.

Source

proxy

Get the proxy to use when connecting. Note: Crystal's HTTP::Client and by extension Halite do not yet support proxy's. Therefore this option does nothing for now.

Source

proxy=(val)

Set the proxy to use when connecting. Note: Crystal's HTTP::Client and by extension Halite do not yet support proxy's. Therefore this option does nothing for now.

Source

reset!

Source

ssl_verify_mode

Get the OpenSSL verify mode to use for SSL connections. 0 is OpenSSL::SSL::NONE 1 is OpenSSL::SSL::PEER

Source

ssl_verify_mode=(mode)

Set the OpenSSL verify mode to use for SSL connections. 0 is OpenSSL::SSL::NONE 1 is OpenSSL::SSL::PEER

Source

user_agent

Get the User Agent header to be passed to all requests.

Source

user_agent=(val)

Set the User Agent header to be passed to all requests.

Source

web_endpoint

Base URL for generated web URLs

Source

web_endpoint=(val)

Set the web endpoint.

Source