Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package gitlab-unix
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Gitlab.APISource
Perform GitLab API requests.
code_handler ~expected_code parse is a response handler that fires for responses with status expected_code and applies parse.
Source
val get :
?fail_handlers:'a parse handler list ->
?expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a parse ->
'a Response.t Monad.tget ?rate ?fail_handlers ?expected_code ?headers ?token ?params uri p is the p-parsed response to a GitLab API HTTP GET request to uri with extra query parameters params and extra headers headers. If token is supplied, it will be used instead of any token bound into the monad. p will only fire if the response status is expected_code which defaults to 200 OK. If the response status is not expected_code, fail_handlers, if any, will be checked in the order supplied. The rate parameter determines which rate limit accounting regime will be used for caching rate limit values in response headers.
Source
val get_stream :
?fail_handlers:'a Stream.parse handler list ->
?expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a Stream.parse ->
'a Stream.tget_stream uri stream_p is the Stream.t encapsulating lazy stream_p-parsed responses to GitLab API HTTP GET requests to uri and its successors. For an explanation of the other parameters, see get.
Source
val post :
?fail_handlers:'a parse handler list ->
expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?body:string ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a parse ->
'a Response.t Monad.tpost uri p is the p-parsed response to a GitLab API HTTP POST request to uri. For an explanation of the other parameters, see get.
Source
val delete :
?fail_handlers:'a parse handler list ->
?expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a parse ->
'a Response.t Monad.tdelete uri p is the p-parsed response to a GitLab API HTTP DELETE request to uri. For an explanation of the other parameters, see get.
Source
val patch :
?fail_handlers:'a parse handler list ->
expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?body:string ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a parse ->
'a Response.t Monad.tpatch uri p is the p-parsed response to a GitLab API HTTP PATCH request to uri. For an explanation of the other parameters, see get.
Source
val put :
?fail_handlers:'a parse handler list ->
expected_code:Cohttp.Code.status_code ->
?headers:Cohttp.Header.t ->
?body:string ->
?token:Token.t ->
?params:(string * string) list ->
uri:Uri.t ->
'a parse ->
'a Response.t Monad.tput uri p is the p-parsed response to a GitLab API HTTP PUT request to uri. For an explanation of the other parameters, see get.
set_user_agent ua contains monadic state that will cause bound requests to use the User-Agent header value of ua.
set_token token contains monadic state that will cause bound requests to use token for authentication by default. This function enables the creation of large, generic monadic compositions that do not have to be parameterized by authentication token.
get_rate () is the cached rate limit information.
get_rate_limit () is the cached total request quota for the current token.
get_rate_remaining () is the cached remaining request quota for the current token.
get_rate_reset () is the cached, UNIX epoch expiry time (s) when the remaining request quota will be reset to the total request quota for the current token.
string_of_message message is the English language error message that GitLab generated in message.