package ez_api

  1. Overview
  2. Docs

Module EzAPISource

Sourcemodule Arg : sig ... end
Sourcemodule Url : sig ... end
Sourcemodule Security : sig ... end
Sourcemodule Param : sig ... end
Sourcemodule Err : sig ... end
Sourcemodule Meth : sig ... end
Sourcemodule Service : sig ... end
Sourcemodule Mime : sig ... end
Sourcemodule Path : sig ... end
Sourcemodule Doc : sig ... end
Sourcemodule Error_codes : sig ... end
Sourcemodule Req : sig ... end
Sourcemodule IO = Service.IO
Sourcemodule TYPES : sig ... end
include module type of struct include TYPES end
include module type of struct include Url.TYPES end
Sourcetype base_url = Url.TYPES.base_url =
  1. | BASE of string
Sourcetype url = Url.TYPES.url =
  1. | URL of string
Sourcetype param_value = TYPES.param_value =
  1. | I of int
  2. | S of string
  3. | B of bool
  4. | LS of string list
Sourcetype ip_info = TYPES.ip_info = {
  1. ip_ip : string;
  2. mutable ip_last : float;
  3. mutable ip_nb : int;
  4. ip_country : string * string;
}
Sourcetype no_security = Security.none
Sourcetype 'b io = 'b IO.io =
  1. | Empty : unit io
  2. | Json : 'a Json_encoding.encoding -> 'a io
  3. | Raw : Mime.t list -> string io
Sourcetype ('args, 'input, 'output, 'error, 'security) service = {
  1. s : ('args, 'input, 'output, 'error, 'security) Service.t;
  2. doc : Doc.t;
}
Sourcetype ('output, 'error, 'security) service0 = (Req.t, unit, 'output, 'error, 'security) service
Sourcetype ('arg, 'output, 'error, 'security) service1 = (Req.t * 'arg, unit, 'output, 'error, 'security) service
Sourcetype ('arg1, 'arg2, 'output, 'error, 'security) service2 = ((Req.t * 'arg1) * 'arg2, unit, 'output, 'error, 'security) service
Sourcetype ('input, 'output, 'error, 'security) post_service0 = (Req.t, 'input, 'output, 'error, 'security) service
Sourcetype ('arg, 'input, 'output, 'error, 'security) post_service1 = (Req.t * 'arg, 'input, 'output, 'error, 'security) service
Sourcetype ('arg1, 'arg2, 'input, 'output, 'error, 'security) post_service2 = ((Req.t * 'arg1) * 'arg2, 'input, 'output, 'error, 'security) service
Sourcetype ('input, 'output, 'error, 'security) ws_service0 = (Req.t, 'input, 'output, 'error, 'security) service
Sourcetype ('arg, 'input, 'output, 'error, 'security) ws_service1 = (Req.t * 'arg, 'input, 'output, 'error, 'security) service
Sourcetype ('arg1, 'arg2, 'input, 'output, 'error, 'security) ws_service2 = ((Req.t * 'arg1) * 'arg2, 'input, 'output, 'error, 'security) service
Sourceval warning : string -> unit
Sourceval warnings : (string -> unit) -> unit
Sourceval encode_params : ('a, 'b, 'c, 'd, [< Security.scheme ]) Service.t -> (Param.t * param_value) list -> string
Sourceval forge : Url.base_url -> ('a, 'b, 'c, 'd, [< Security.scheme ]) service -> 'a -> (Param.t * param_value) list -> Url.url
Sourceval forge0 : Url.base_url -> (Req.t, 'a, 'b, 'c, [< Security.scheme ]) service -> (Param.t * param_value) list -> Url.url
Sourceval forge1 : Url.base_url -> (Req.t * 'a, 'b, 'c, 'd, [< Security.scheme ]) service -> 'a -> (Param.t * param_value) list -> Url.url
Sourceval forge2 : Url.base_url -> ((Req.t * 'a) * 'b, 'c, 'd, 'e, [< Security.scheme ]) service -> 'a -> 'b -> (Param.t * param_value) list -> Url.url
Sourceval raw_service : 'i. ?section:??? -> ?name:??? -> ?descr:??? -> ?meth:??? -> input:'i io -> output:'o io -> ?errors:??? -> ?params:??? -> ?security:??? -> ?access_control:??? -> ?register:??? -> ?input_example:??? -> ?output_example:??? -> (Req.t, 'a) Path.t -> ('a, 'i, 'o, 'e, 'b) service
Sourceval post_service : ?section:??? -> ?name:??? -> ?descr:??? -> ?meth:??? -> input:'a Json_encoding.encoding -> output:'b Json_encoding.encoding -> ?errors:??? -> ?params:??? -> ?security:??? -> ?register:??? -> ?access_control:??? -> ?input_example:??? -> ?output_example:??? -> (Req.t, 'e) Path.t -> ('e, 'a, 'b, 'c, 'd) service
Sourceval service : ?section:??? -> ?name:??? -> ?descr:??? -> ?meth:??? -> output:'a Json_encoding.encoding -> ?errors:??? -> ?params:??? -> ?security:??? -> ?access_control:??? -> ?register:??? -> ?output_example:??? -> (Req.t, 'd) Path.t -> ('d, unit, 'a, 'b, 'c) service
Sourceval ws_service : ?section:??? -> ?name:??? -> ?descr:??? -> input:'a io -> output:'b io -> ?errors:??? -> ?params:??? -> ?security:??? -> ?access_control:??? -> ?register:??? -> ?output_example:??? -> (Req.t, 'e) Path.t -> ('e, 'a, 'b, 'c, 'd) service
Sourceval register : ('a, 'b, 'c, 'd, [< Security.scheme ] as 'e) service -> ('a, 'b, 'c, 'd, 'e) Service.t
Sourceval id : ('a, 'b, 'c, 'd, [< Security.scheme ]) service -> int
Sourcemodule Legacy : sig ... end