module Octokit::Configurable
Configuration options for {Client}, defaulting to values in {Default}
Attributes
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
@!attribute [w] access_token
@see https://developer.github.com/v3/oauth/ @return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.github.com/
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute [w] bearer_token
@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration @return [String] JWT bearer token for authentication
@!attribute client_id
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app key
@!attribute [w] client_secret
@see https://developer.github.com/v3/oauth/ @return [String] Configure OAuth app secret
@!attribute default_media_type
@see https://developer.github.com/v3/media/ @return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute login
@return [String] GitHub username for Basic Authentication
@!attribute management_console_password
@return [String] An admin password set up for your GitHub Enterprise management console
@!attribute management_console_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise management console
@!attribute manage_ghes_endpoint
@return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_username
@return [String] API username for requests to the GitHub Enterprise Server Manage API
@!attribute manage_ghes_password
@return [String] API user password for requests to the GitHub Enterprise Server Manage API
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Octokit to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute [w] password
@return [String] GitHub password for Basic Authentication
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute ssl_verify_mode
@see https://github.com/lostisland/faraday @return [String] SSL verify mode for ssl connections
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://github.com/
Public Class Methods
Source
# File lib/octokit/configurable.rb, line 76 def keys @keys ||= %i[ access_token api_endpoint auto_paginate bearer_token client_id client_secret connection_options default_media_type login management_console_endpoint management_console_password manage_ghes_endpoint manage_ghes_username manage_ghes_password middleware netrc netrc_file per_page password proxy ssl_verify_mode user_agent web_endpoint ] end
List of configurable keys for {Octokit::Client} @return [Array] of option keys
Public Instance Methods
Source
# File lib/octokit/configurable.rb, line 133 def api_endpoint File.join(@api_endpoint, '') end
Source
# File lib/octokit/configurable.rb, line 106 def configure yield self end
Set configuration options using a block
Source
# File lib/octokit/configurable.rb, line 152 def login @login ||= (user.login if token_authenticated?) end
Source
# File lib/octokit/configurable.rb, line 141 def manage_ghes_endpoint File.join(@manage_ghes_endpoint, '') end
Source
# File lib/octokit/configurable.rb, line 137 def management_console_endpoint File.join(@management_console_endpoint, '') end
Source
# File lib/octokit/configurable.rb, line 111 def reset! # rubocop:disable Style/HashEachMethods # # This may look like a `.keys.each` which should be replaced with `#each_key`, but # this doesn't actually work, since `#keys` is just a method we've defined ourselves. # The class doesn't fulfill the whole `Enumerable` contract. Octokit::Configurable.keys.each do |key| # rubocop:enable Style/HashEachMethods instance_variable_set(:"@#{key}", Octokit::Default.options[key]) end self end
Reset configuration options to default values
Source
# File lib/octokit/configurable.rb, line 129 def same_options?(opts) opts.hash == options.hash end
Compares client options to a Hash of requested options
@param opts [Hash] Options to compare with current client options @return [Boolean]
Source
# File lib/octokit/configurable.rb, line 148 def web_endpoint File.join(@web_endpoint, '') end
Base URL for generated web URLs
@return [String] Default: github.com/
Private Instance Methods
Source
# File lib/octokit/configurable.rb, line 166 def fetch_client_id_and_secret(overrides = {}) opts = options.merge(overrides) opts.values_at :client_id, :client_secret end
Source
# File lib/octokit/configurable.rb, line 162 def options Octokit::Configurable.keys.to_h { |key| [key, instance_variable_get(:"@#{key}")] } end