Module `EzOpenAPI`Source

Sourcemodule Types : sig ... end

Sourcemodule Makers : sig ... end

Sourcemodule Encoding : sig ... end

val make_query_param : 
  ?definitions:Json_schema.schema ->
  EzAPI.Param.t ->
  Types.param_object * Json_schema.schema

Sourceval make_path_params : EzAPI.Arg.descr list -> Types.param_object list

Source

val empty_schema : 
  none:'a ->
  Json_schema.schema ->
  (Json_schema.schema -> 'a) ->
  'a

Source

val make_request : 
  ?example:Json_repr.any ->
  string list ->
  Json_schema.schema option ->
  Types.request_object option

Source

val merge_definitions : 
  ?definitions:Json_schema.schema ->
  EzAPI.Doc.t ->
  Json_schema.schema option
  * (int * Json_schema.schema) list
  * Json_schema.schema

Source

val make_path : 
  ?docs:
    (string * (string * string * Json_repr.any option * Json_repr.any option))
      list ->
  definitions:Json_schema.schema ->
  ('a * EzAPI.Doc.t list) ->
  ('a * Types.path_item) * Json_schema.schema

Source

val definitions_schemas : 
  Json_schema.schema ->
  (string * Json_repr.any) list option

Source

val json_map : 
  (Json_repr.ezjsonm -> Json_repr.ezjsonm) ->
  Json_repr.ezjsonm ->
  Json_repr.ezjsonm

Sourceval fix_descr_ref : Json_repr.ezjsonm -> Json_repr.ezjsonm

Source

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 ->
  ?definitions:Json_schema.schema ->
  sections:EzAPI.Doc.section list ->
  title:string ->
  string ->
  string * string

Source

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 ->
  ?definitions:Json_schema.schema ->
  sections:EzAPI.Doc.section list ->
  title:string ->
  string ->
  unit

Source

val exec : 
  ?docs:
    (string * (string * string * Json_repr.any option * Json_repr.any option))
      list ->
  ?definitions:Json_schema.schema ->
  EzAPI.Doc.section list ->
  unit

Source

val executable : 
  docs:
    (string * (string * string * Json_repr.any option * Json_repr.any option))
      list ->
  sections:EzAPI.Doc.section list ->
  unit

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ez_api.openAPI/EzOpenAPI/index.html

Module `EzOpenAPI`Source

package ez_api

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ez_api.openAPI/EzOpenAPI/index.html

Module EzOpenAPISource

Module `EzOpenAPI`Source