package ez_api

  1. Overview
  2. Docs
Easy API library and tools

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (8)

Authors

  1. C
    Cagdas Bozman <cagdas.bozman@ocamlpro.com>
  2. M
    Michael Laporte <michael.laporte@ocamlpro.com>
  3. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>
  4. M
    Maxime Levillain <maxime.levillain@ocamlpro.com>
  5. A
    Alain Mebsout <alain.mebsout@ocamlpro.com>

Maintainers

  1. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>

Sources

v2.0.0.tar.gz
md5=ed68e0a33325ecf6a3319cafa636d62e
sha512=425c6289d568cf697e8d9977ac43e2ebcdeec8f04f5a17225824d5a37ac700961e5d1283b92aeaebaf58ccfb5b4261bcba1180ab11c267ade0de86b68fd6ca2d

doc/ez_api/EzAPI/Doc/index.html

Module EzAPI.DocSource

Sourcetype t = {
  1. doc_id : int;
  2. doc_name : string option;
  3. doc_descr : string option;
  4. doc_path : string;
  5. doc_args : Arg.descr list;
  6. doc_params : Param.t list;
  7. mutable doc_registered : bool;
  8. doc_section : section;
  9. doc_input : Json_schema.schema Lazy.t option;
  10. doc_output : Json_schema.schema Lazy.t option;
  11. doc_mime : Mime.t list;
  12. doc_errors : (int * Json_schema.schema Lazy.t) list;
  13. doc_meth : Meth.t;
  14. doc_security : Security.scheme list;
  15. doc_input_example : Json_repr.any option;
  16. doc_output_example : Json_repr.any option;
}
Sourceand section = {
  1. section_name : string;
  2. mutable section_docs : t list;
}
Sourceval default_section : section
Sourceval sections : section list ref
Sourceval definitions_path : string
Sourceval update_service_list : t list -> t -> t list
Sourceval make : 'i. ?name:??? -> ?descr:??? -> ?register:??? -> ?section:??? -> ?input_example:??? -> ?output_example:??? -> ('a, 'i, 'o, 'b, [< `Basic of Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc & Security.basic_desc | `Bearer of Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc & Security.bearer_desc | `Cookie of string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option & string Security.apikey * int64 option | `Header of string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey & string Security.apikey | `Nosecurity of Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited & Security.uninhabited | `Query of Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey & Param.t Security.apikey ]) Service.t -> t
Sourceval section : string -> section
Sourceval all_services_registered : unit -> bool
Sourceval section_name : section -> string
Sourceval nservices : unit -> int
Sourceval services : unit -> string array