module Octokit::Configurable

Overview

Provides configuration options for Client.

Direct including types

• Octokit::Client

Defined in:

Instance Method Summary

• #access_token

  Get access token for authentication.

• #access_token=(token)

  Set access token for authentication.

• #add_middleware(middleware : Halite::Feature)

  Add middleware to the middleware stack.

• #api_endpoint

  API endpoint for Client.

• #api_endpoint=(val)

  Set the api endpoint.

• #auto_paginate

  Do we want to auto paginate.

• #auto_paginate=(val)

  Set if we want to auto paginate.

• #bearer_token

  Get the bearer token.

• #bearer_token=(token)

  Set the bearer token.

• #client_id

  Get the Client ID.

• #client_id=(val)

  Set the Client ID.

• #client_secret

  Get the Client Secret.

• #client_secret=(val)

  Set the Client secret.

• #configure(&)

  Yield a block allowing configuration of options.

• #connection_options

  Get the default connection options passed to Halite.

• #connection_options=(val)

  Set the default connection options passed to Halite.

• #default_media_type

  Get the default media type for headers.

• #default_media_type=(val)

  Set the default media type for headers.

• #logger

  Get the configured logger instance.

• #logger=(val)

  Set a configured logger instance.

• #login

  The username of the authenticated user

• #login=(val)

  Set the user login.

• #management_console_endpoint

  API endpoint for EnterpriseManagementConsoleClient

• #management_console_endpoint=(val)

  Set the management console password.

• #middleware

  Get the middleware stack for Halite.

• #middleware=(val)

  Set the middleware stack for Halite.

• #password=(val)

  Set the user password.

• #per_page

  Get the maximum results returned per page for paginated endpoints.

• #per_page=(val)

  Set the maximum results returned per page for paginated endpoints.

• #proxy

  Get the proxy to use when connecting.

• #proxy=(val)

  Set the proxy to use when connecting.

• #reset!
• #ssl_verify_mode

  Get the OpenSSL verify mode to use for SSL connections.

• #ssl_verify_mode=(mode)

  Set the OpenSSL verify mode to use for SSL connections.

• #user_agent

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

• #user_agent=(val)

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

• #web_endpoint

  Base URL for generated web URLs

• #web_endpoint=(val)

  Set the web endpoint.

Instance Method Detail

@client.configure do
  auto_paginate = true
end