package gitlab-unix

  1. Overview
  2. Docs

Module GitlabSource

include Gitlab_s.Gitlab
Sourcetype rate_limit = {
  1. limit : int;
  2. remaining : int;
  3. reset : float;
}
Sourcetype rates = {
  1. core : rate_limit option;
}
Sourcemodule Response : sig ... end

Functions 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.

Sourcemodule Monad : sig ... end

All API requests are bound through this monad which encapsulates an Lwt cooperative thread and includes some state which may be set via API functions.

Sourcemodule Token : sig ... end

Authentication Token for accessing GitLab APIs.

Sourcetype +'a parse = string -> 'a Lwt.t

'a parse is the type of functions which extract meaningful values from GitLab responses.

Sourcetype '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).

Sourcemodule Endpoint : sig ... end

Each request to GitLab is made to a specific Endpoint in GitLab's REST-like API.

Sourcemodule Stream : sig ... end

The Stream module provides an abstraction to GitLab's paginated endpoints. Stream creation does not initiate any network activity. When requests are made, results are buffered internally. Streams are not mutable.

Sourcemodule API : sig ... end
Sourcemodule Event : sig ... end
Sourcemodule User : sig ... end

The User module provides access to User API.

Sourcemodule Project : sig ... end

The Project module provides access to Project API.

Sourcemodule Group : sig ... end

The Group module provides access to Group API.