package ez_api
Easy API library and tools
Install
Dune Dependency
Authors
Maintainers
Sources
2.1.0.tar.gz
md5=e1d03d141ef977fbd4521256c91431f1
sha512=51b0cc4e6afb0cd5ab55c0c40964946b79e0c2cc903b5d08c594292eec723a25e25463175d704c02fe559e2af5d95973514c248a603ad28ec0230c35ad2d6492
doc/ez_api.openAPI/EzOpenAPI/Makers/index.html
Module EzOpenAPI.MakersSource
Source
val mk_info :
?descr:string ->
?terms:string ->
?contact:Types.contact_object ->
?license:Types.license_object ->
version:string ->
string ->
Types.openapi_infoSource
val mk_server_variable :
?enum:string list ->
?descr:string ->
string ->
Types.server_variable_objectSource
val mk_server :
?descr:string ->
?variables:(string * Types.server_variable_object) list ->
string ->
Types.server_objectSource
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_objectSource
val mk_media :
?schema:Json_schema.schema ->
?example:Json_repr.any ->
?encoding:Types.encoding_object ->
unit ->
Types.media_type_objectSource
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_objectSource
val mk_request :
?descr:string ->
?required:bool ->
(string * Types.media_type_object) list ->
Types.request_objectSource
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_objectSource
val mk_path :
?oref:string ->
?summary:string ->
?descr:string ->
?servers:Types.server_object list ->
?params:Types.param_object list ->
(string * Types.operation_object) list ->
Types.path_itemSource
val mk_example :
?summary:string ->
?descr:string ->
?value:Json_repr.any ->
?ext:string ->
unit ->
Types.example_objectSource
val mk_security_scheme :
?descr:string ->
?name:string ->
?loc:string ->
?scheme:string ->
?format:string ->
?connect_url:string ->
string ->
Types.security_scheme_objectSource
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_objectSource
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