package ez_api

  1. Overview
  2. Docs

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: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