package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Library
Module
Module type
Parameter
Class
Class type
val mk_contact : ?name:string -> ?url:string -> ?email:string -> unit -> Types.contact_object
val mk_licence : ?url:string -> string -> Types.license_object
val mk_info : ?descr:string -> ?terms:string -> ?contact:Types.contact_object -> ?license:Types.license_object -> version:string -> string -> Types.openapi_info
val mk_server_variable : ?enum:string list -> ?descr:string -> string -> Types.server_variable_object
val mk_server : ?descr:string -> ?variables:(string * Types.server_variable_object) list -> string -> Types.server_object
val mk_param : ?descr:string -> ?required:bool -> ?deprecated:bool -> ?allow_empty:bool -> ?style:string -> ?example:Json_repr.any -> ?schema:Json_schema.schema -> ?loc:string -> string -> Types.param_object
val mk_media : ?schema:Json_schema.schema -> ?example:Json_repr.any -> ?encoding:Types.encoding_object -> unit -> Types.media_type_object
val mk_response : ?headers:(string * Types.param_object) list -> ?content:(string * Types.media_type_object) list -> ?links:(string * Types.link_object) list -> string -> Types.response_object
val mk_request : ?descr:string -> ?required:bool -> (string * Types.media_type_object) list -> Types.request_object
val mk_operation : ?tags:string list -> ?summary:string -> ?descr:string -> ?extern:Types.external_doc_object -> ?id:string -> ?params:Types.param_object list -> ?request:Types.request_object -> ?deprecated:bool -> ?security:EzAPI.Security.scheme list -> ?servers:Types.server_object list -> (string * Types.response_object) list -> Types.operation_object
val mk_path : ?oref:string -> ?summary:string -> ?descr:string -> ?servers:Types.server_object list -> ?params:Types.param_object list -> meth:string -> Types.operation_object -> Types.path_item
val mk_example : ?summary:string -> ?descr:string -> ?value:Json_repr.any -> ?ext:string -> unit -> Types.example_object
val mk_security_scheme : ?descr:string -> ?name:string -> ?loc:string -> ?scheme:string -> ?format:string -> ?connect_url:string -> string -> Types.security_scheme_object
val mk_components : ?schemas:(string * Json_repr.any) list -> ?responses:(string * Types.response_object) list -> ?parameters:(string * Types.param_object) list -> ?examples:(string * Types.example_object) list -> ?requests:(string * Types.request_object) list -> ?headers:(string * Types.param_object) list -> ?security:EzAPI.Security.scheme list -> ?links:(string * Types.link_object) list -> unit -> Types.components_object
val mk_openapi : ?version:string -> ?servers:Types.server_object list -> ?components:Types.components_object -> ?security:EzAPI.Security.scheme list -> ?tags:string list -> ?extern:Types.external_doc_object -> info:Types.openapi_info -> (string * Types.path_item) list -> Types.openapi_object