exception Message of Cohttp.Code.status_code * Github_t.messageMessage may be raised by any API call when the GitHub service returns an unexpected response code. Typical reasons for this exception are insufficient permissions or missing resources.
module Response : sig ... endFunctions corresponding to direct API requests return Response.t values inside of Monad.t values so that more information about the request can be made available. Monad.(>>~) is a convenience operator that lets you bind directly to the carried value.
module Monad : sig ... endAll API requests are bound through this monad which encapsulates an Lwt cooperative thread and includes some state which may be set via API functions.
module Endpoint : sig ... endEach request to GitHub is made to a specific Endpoint in GitHub's REST-like API.
module Stream : sig ... endThe Stream module provides an abstraction to GitHub's paginated endpoints. Stream creation does not initiate any network activity. When requests are made, results are buffered internally. Streams are not mutable.
rate is a type used to indicate which rate-limiting regime is to be used for query quota accounting. rate is used by the function in API.
Some results may require 2-factor authentication. Result values do not. Two_factor values contain the mode by which a 2FA code will be delivered. This code is required as ?otp to a subsequent invocation of the function which returns this type.
type +'a parse = string -> 'a Lwt.t'a parse is the type of functions which extract meaningful values from GitHub responses.
type 'a handler = ((Cohttp.Response.t * string) -> bool) * 'a'a handler is the type of response handlers which consist of an activation predicate (fst) and a parse function (snd).
log_active regulates debug messages. It is true by default when the environment variable GITHUB_DEBUG is set to 1.
module Scope : sig ... endThe Scope module abstracts GitHub's authorization scopes.
module Token : sig ... endThe Token module manipulates authorization tokens. GitHub has two types of tokens: OAuth application tokens and "personal tokens".
module API : sig ... endThe API module contains functionality that relates to the entirety of the GitHub API and these bindings. In particular, this module contains:
module URI : sig ... endThe URI module contains URI generation functions which may be useful for linking on the Web or passing to other GitHub API clients.
module Filter : sig ... endThe Filter module contains types used by search and enumeration interfaces which describe ways to perform result filtering directly in the GitHub API.
module Rate_limit : sig ... endThe Rate_limit module contains explicit rate limit API request functions which do not read the rate limit cache but do write to it.
module User : sig ... endThe User module provides basic user information query functions.
module Organization : sig ... endThe Organization module exposes the functionality of the GitHub organization API.
module Repo : sig ... endThe Repo module offers the functionality of GitHub's repository API.
module Stats : sig ... endThe Stats module exposes the functionality of GitHub's repository statistics API which provides historical data regarding the aggregate behavior of a repository.
module Status : sig ... endThe Status module provides the functionality of GitHub's status API.
module Pull : sig ... endThe Pull module contains functionality relating to GitHub's pull request API.
module Label : sig ... endThe Label module exposes Github's labels API.
module Collaborator : sig ... endThe Collaborator module exposes Github's collaborators API.
module Milestone : sig ... endThe Milestone module exposes GitHub's milestone API.
module Release : sig ... endThe Release module provides access to GitHub's release API features.
module Deploy_key : sig ... endThe Deploy_key module provides the means to manage per-repository deploy keys.
module Search : sig ... endThe Search module exposes GitHub's search interfaces.
module Git_obj : sig ... endThe Git_obj module contains utility functions for working with git concepts.