package gitlab-jsoo

  1. Overview
  2. Docs
Gitlab APIv4 OCaml library

Install

Dune Dependency

Authors

Maintainers

Sources

gitlab-0.1.8.tbz
sha256=06e430f4ab919c3417374d9628ce7ebfd49b6a901129a6e6fa1cdd53c2daae42
sha512=04c5c7131fa5a630edd0d2c605084fb37bb6a4d875b208450bf3b3fb70dc17da0f9ed8de04271e4eea62168d77dbcdda139aa7fe1a40f06f6c6cfb4407c47680

doc/gitlab-jsoo/Gitlab/index.html

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;
}
Sourceexception Message of Cohttp.Code.status_code * Gitlab_t.message
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 Scope : sig ... end

The Scope module abstracts GitLab's authorization scopes.

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

Perform GitLab API requests.

Sourcemodule Event : sig ... end

User contribution events.

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.

Sourcemodule Runners : sig ... end

The Runners module provides access to Runners API.

OCaml

Innovation. Community. Security.