package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module EzAPI.DocSource

Sourcetype t = {
  1. mutable 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. doc_section : section;
  8. doc_input : Json_schema.schema Lazy.t option;
  9. doc_output : Json_schema.schema Lazy.t option;
  10. doc_mime : Mime.t list;
  11. doc_errors : (int * Json_schema.schema Lazy.t) list;
  12. doc_meth : Meth.t;
  13. doc_security : Security.scheme list;
  14. doc_input_example : Json_repr.any option;
  15. doc_output_example : Json_repr.any option;
  16. doc_hide : bool;
  17. doc_register : bool;
}
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 make : 'i. ?name:string -> ?descr:string -> ?register:bool -> ?hide:bool -> ?section:section -> ?input_example:'i -> ?output_example:'o -> ('a, 'i, 'o, 'b, [< Security.scheme ]) Service.t -> t
Sourceval update_service_list : t list -> t -> t list
Sourceval register : t -> unit
Sourceval section : string -> section
Sourceval all_services_registered : unit -> bool
Sourceval section_name : section -> string
Sourceval nservices : unit -> int
Sourceval services : unit -> string array
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct