package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Types : sig ... end
module Makers : sig ... end
module Encoding : sig ... end
val make_query_param : ?definitions:Json_schema.schema -> EzAPI.Param.t -> Types.param_object * Json_schema.schema
val make_path_params : EzAPI.Arg.descr list -> Types.param_object list
val empty_schema : none:'a -> Json_schema.schema -> (Json_schema.schema -> 'b) -> 'c
val make_request : ?example:Json_repr.any -> string list -> Json_schema.schema option -> Types.request_object option
val merge_definitions : ?definitions:Json_schema.schema -> EzAPI.Doc.t -> Json_schema.schema option * (int * Json_schema.schema) list * Json_schema.schema
val make_path : ?docs: (string * (string * string * Json_repr.any option * Json_repr.any option)) list -> ?definitions:Json_schema.schema -> EzAPI.Doc.t -> (string * Types.path_item) * Json_schema.schema
val definitions_schemas : Json_schema.schema -> (string * Json_repr.any) list option
val fix_descr_ref : Json_repr.ezjsonm -> Json_repr.ezjsonm
val make : ?descr:string -> ?terms:string -> ?contact:Types.contact_object -> ?license:Types.license_object -> ?version:string -> ?servers:Types.server_object list -> ?docs: (string * (string * string * Json_repr.any option * Json_repr.any option)) list -> ?yaml:bool -> ?pretty:bool -> sections:EzAPI.Doc.section list -> title:string -> string -> string * string
val write : ?descr:string -> ?terms:string -> ?contact:Types.contact_object -> ?license:Types.license_object -> ?version:string -> ?servers:Types.server_object list -> ?docs: (string * (string * string * Json_repr.any option * Json_repr.any option)) list -> ?yaml:bool -> ?pretty:bool -> sections:EzAPI.Doc.section list -> title:string -> string -> unit
val executable : sections:EzAPI.Doc.section list -> docs: (string * (string * string * Json_repr.any option * Json_repr.any option)) list -> unit