package gitlab-unix

You can search for identifiers within the package.

in-package search v0.2.0

gitlab-unix
- Gitlab
  - API
  - Endpoint
    
    Version
  - Event
  - Group
    
    Milestone
    
    Project
  - Monad
  - Project
    
    Branch
    
    Commit
    
    ExternalStatusCheck
    
    Milestone
    
    ProjectAccessToken
  - Response
  - Stream
  - Token
  - User
    
    PersonalAccessToken

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

type redirect =

| Temporary of Uri.t
(*
The redirection is temporary.
*)
| Permanent of Uri.t
(*
The redirection is permanent.
*)

redirect indicates whether the originally requested endpoint should continue to be used in the future.

type 'a t = private < value : 'a ; redirects : redirect list.. >

'a t is an API response containing a payload of type 'a. Do not refer to this type explicitly as its identity and representation are subject to change (e.g. a family of object types may replace it before 3.0).

val value : < value : 'a.. > -> 'a

value r is the payload in response r.

val redirects : < redirects : redirect list.. > -> redirect list

redirects r is the sequence of redirects prior to response r.

val final_resource : redirect list -> redirect option

final_resource rs is the single redirect, if any redirects occurred, that describes the overall redirect chain rs. If any redirect rs is temporary, final_resource rs will be a temporary redirect to the final URI. If all redirects rs are permanent, final_resource rs will be a permanent redirect to the final URI.