package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

Easy API library and tools

Install

Dune Dependency

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

Authors

Maintainers

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.Doc`Source

Sourcetype t = {

doc_id : int;
doc_name : string option;
doc_descr : string option;
doc_path : string;
doc_args : Arg.descr list;
doc_params : Param.t list;
mutable doc_registered : bool;
doc_section : section;
doc_input : Json_schema.schema Lazy.t option;
doc_output : Json_schema.schema Lazy.t option;
doc_mime : Mime.t list;
doc_errors : (int * Json_schema.schema Lazy.t) list;
doc_meth : Meth.t;
doc_security : Security.scheme list;
doc_input_example : Json_repr.any option;
doc_output_example : Json_repr.any option;

}

Sourceand section = {

section_name : string;
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

Source

val make : 
  'i. ?name:string ->
  ?descr:string ->
  ?register:bool ->
  ?section:section ->
  ?input_example:'i ->
  ?output_example:'o ->
  ('a, 'i, 'o, 'b, [< Security.scheme ]) 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