package openapi

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Yojson_conv = Ppx_yojson_conv_lib.Yojson_conv
type 'a map = (string * 'a) list
val yojson_of_map : ('a -> Yojson.Safe.t) -> (string * 'b) list -> Yojson.Safe.t
val map_of_yojson : (Yojson.Safe.t -> 'a) -> Yojson.Safe.t -> 'a0 map
type any = Yojson.Safe.t
val pp_any : Format.formatter -> Yojson.Safe.t -> unit
val any_of_yojson : 'a -> 'b
val yojson_of_any : 'a -> 'b
type any_map = any map
val show_any_map : any_map -> Ppx_deriving_runtime.string
val any_map_of_yojson : Yojson.Safe.t -> Yojson.Safe.t map
val yojson_of_any_map : (string * Yojson.Safe.t) list -> Yojson.Safe.t
type 'a or_ref =
  1. | Obj of 'a
  2. | Ref of string
val yojson_of_or_ref : ('a -> [> `Assoc of (string * [> `String of string ]) list ] as 'b) -> 'c or_ref -> 'd
val or_ref_of_yojson : ([> `Assoc of (string * [> `String of string ]) list ] as 'a -> 'b) -> 'c -> 'd or_ref
val pp_or_ref : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a0 or_ref -> unit
type json_schema_type =
  1. | Null
  2. | Boolean
  3. | Object
  4. | Array
  5. | Number
  6. | String
  7. | Integer
val string_of_json_schema_type : json_schema_type -> string
val json_schema_type_of_yojson : Yojson.Safe.t -> json_schema_type
val yojson_of_json_schema_type : json_schema_type -> Yojson.Safe.t
val pp_json_schema_type : Format.formatter -> json_schema_type -> unit
type schema = {
  1. schema : string option;
  2. id_ : string option;
  3. title : string option;
  4. description : string option;
  5. default : any option;
  6. examples : any list option;
  7. read_only : bool option;
  8. write_only : bool option;
  9. comment : string option;
  10. typ : json_schema_type or_ref option;
  11. enum : any list option;
  12. const : any option;
  13. multiple_of : float option;
  14. minimum : float option;
  15. exclusiveMinimum : float option;
  16. maximum : float option;
  17. exclusiveMaximum : float option;
  18. properties : schema or_ref map option;
  19. pattern_properties : schema or_ref map option;
  20. additional_properties : schema or_ref option;
  21. required : string list option;
  22. property_names : schema or_ref option;
  23. min_properties : int option;
  24. max_properties : int option;
  25. min_items : int option;
  26. max_items : int option;
  27. items : schema or_ref option;
  28. prefix_items : schema or_ref list option;
  29. format : string option;
  30. pattern : string option;
  31. min_length : int option;
  32. max_length : int option;
  33. all_of : schema or_ref list option;
  34. any_of : schema or_ref list option;
  35. one_of : schema or_ref list option;
}
val make_schema : ?schema:string -> ?id_:string -> ?title:string -> ?description:string -> ?default:any -> ?examples:any list -> ?read_only:bool -> ?write_only:bool -> ?comment:string -> ?typ:json_schema_type or_ref -> ?enum:any list -> ?const:any -> ?multiple_of:float -> ?minimum:float -> ?exclusiveMinimum:float -> ?maximum:float -> ?exclusiveMaximum:float -> ?properties:schema or_ref map -> ?pattern_properties:schema or_ref map -> ?additional_properties:schema or_ref -> ?required:string list -> ?property_names:schema or_ref -> ?min_properties:int -> ?max_properties:int -> ?min_items:int -> ?max_items:int -> ?items:schema or_ref -> ?prefix_items:schema or_ref list -> ?format:string -> ?pattern:string -> ?min_length:int -> ?max_length:int -> ?all_of:schema or_ref list -> ?any_of:schema or_ref list -> ?one_of:schema or_ref list -> unit -> schema
val show_schema : schema -> Ppx_deriving_runtime.string
val schema_of_yojson : Yojson.Safe.t -> schema
val yojson_of_schema : schema -> Ppx_yojson_conv_lib.Yojson.Safe.t
module Helpers : sig ... end