Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
val make_contact_object :
?name:string ->
?url:string ->
?email:string ->
unit ->
contact_object
val pp_contact_object :
Ppx_deriving_runtime.Format.formatter ->
contact_object ->
Ppx_deriving_runtime.unit
val show_contact_object : contact_object -> Ppx_deriving_runtime.string
val contact_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
contact_object
val yojson_of_contact_object :
contact_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
val make_license_object : name:string -> ?url:string -> unit -> license_object
val pp_license_object :
Ppx_deriving_runtime.Format.formatter ->
license_object ->
Ppx_deriving_runtime.unit
val show_license_object : license_object -> Ppx_deriving_runtime.string
val license_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
license_object
val yojson_of_license_object :
license_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
val make_server_variable_object :
?enum:string list ->
default:string ->
?description:string ->
unit ->
server_variable_object
val pp_server_variable_object :
Ppx_deriving_runtime.Format.formatter ->
server_variable_object ->
Ppx_deriving_runtime.unit
val show_server_variable_object :
server_variable_object ->
Ppx_deriving_runtime.string
val server_variable_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
server_variable_object
val yojson_of_server_variable_object :
server_variable_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
val make_external_documentation_object :
?description:string ->
url:string ->
unit ->
external_documentation_object
val pp_external_documentation_object :
Ppx_deriving_runtime.Format.formatter ->
external_documentation_object ->
Ppx_deriving_runtime.unit
val show_external_documentation_object :
external_documentation_object ->
Ppx_deriving_runtime.string
val external_documentation_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
external_documentation_object
val yojson_of_external_documentation_object :
external_documentation_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type server_object = {
url : string;
description : string option;
variables : server_variable_object Json_schema.map option;
}
val make_server_object :
url:string ->
?description:string ->
?variables:server_variable_object Json_schema.map ->
unit ->
server_object
val pp_server_object :
Ppx_deriving_runtime.Format.formatter ->
server_object ->
Ppx_deriving_runtime.unit
val show_server_object : server_object -> Ppx_deriving_runtime.string
val server_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
server_object
val yojson_of_server_object :
server_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type link_object = {
operation_ref : string option;
operation_id : string option;
parameters : Json_schema.any Json_schema.map option;
request_body : Json_schema.any option;
description : string option;
server : server_object option;
}
val make_link_object :
?operation_ref:string ->
?operation_id:string ->
?parameters:Json_schema.any Json_schema.map ->
?request_body:Json_schema.any ->
?description:string ->
?server:server_object ->
unit ->
link_object
val pp_link_object :
Ppx_deriving_runtime.Format.formatter ->
link_object ->
Ppx_deriving_runtime.unit
val show_link_object : link_object -> Ppx_deriving_runtime.string
val link_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> link_object
val yojson_of_link_object : link_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
val make_header_object :
?description:string ->
?required:bool ->
?deprecated:bool ->
?allow_empty_value:bool ->
unit ->
header_object
val pp_header_object :
Ppx_deriving_runtime.Format.formatter ->
header_object ->
Ppx_deriving_runtime.unit
val show_header_object : header_object -> Ppx_deriving_runtime.string
val header_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
header_object
val yojson_of_header_object :
header_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type example_object = {
summary : string option;
description : string option;
value : Json_schema.any option;
externalValue : string option;
}
val make_example_object :
?summary:string ->
?description:string ->
?value:Json_schema.any ->
?externalValue:string ->
unit ->
example_object
val pp_example_object :
Ppx_deriving_runtime.Format.formatter ->
example_object ->
Ppx_deriving_runtime.unit
val show_example_object : example_object -> Ppx_deriving_runtime.string
val example_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
example_object
val yojson_of_example_object :
example_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type media_type_object = {
schema : Json_schema.schema Json_schema.or_ref option;
example : Json_schema.any option;
examples : example_object Json_schema.or_ref Json_schema.map option;
encoding : Json_schema.any Json_schema.map option;
}
val make_media_type_object :
?schema:Json_schema.schema Json_schema.or_ref ->
?example:Json_schema.any ->
?examples:example_object Json_schema.or_ref Json_schema.map ->
?encoding:Json_schema.any Json_schema.map ->
unit ->
media_type_object
val pp_media_type_object :
Ppx_deriving_runtime.Format.formatter ->
media_type_object ->
Ppx_deriving_runtime.unit
val show_media_type_object : media_type_object -> Ppx_deriving_runtime.string
val media_type_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
media_type_object
val yojson_of_media_type_object :
media_type_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type response_object = {
description : string;
headers : header_object Json_schema.or_ref Json_schema.map option;
content : media_type_object Json_schema.map option;
links : link_object Json_schema.or_ref Json_schema.map option;
}
val make_response_object :
description:string ->
?headers:header_object Json_schema.or_ref Json_schema.map ->
?content:media_type_object Json_schema.map ->
?links:link_object Json_schema.or_ref Json_schema.map ->
unit ->
response_object
val pp_response_object :
Ppx_deriving_runtime.Format.formatter ->
response_object ->
Ppx_deriving_runtime.unit
val show_response_object : response_object -> Ppx_deriving_runtime.string
val response_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
response_object
val yojson_of_response_object :
response_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type responses_object = response_object Json_schema.or_ref Json_schema.map
val pp_responses_object :
Ppx_deriving_runtime.Format.formatter ->
responses_object ->
Ppx_deriving_runtime.unit
val show_responses_object : responses_object -> Ppx_deriving_runtime.string
val responses_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
responses_object
val yojson_of_responses_object :
responses_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
val pp_parameter_location :
Ppx_deriving_runtime.Format.formatter ->
parameter_location ->
Ppx_deriving_runtime.unit
val show_parameter_location : parameter_location -> Ppx_deriving_runtime.string
val parameter_location_of_yojson : Yojson.Safe.t -> parameter_location
val yojson_of_parameter_location : parameter_location -> [> `String of string ]
val pp_parameter_style :
Ppx_deriving_runtime.Format.formatter ->
parameter_style ->
Ppx_deriving_runtime.unit
val show_parameter_style : parameter_style -> Ppx_deriving_runtime.string
val parameter_style_of_yojson : Yojson.Safe.t -> parameter_style
val yojson_of_parameter_style : parameter_style -> [> `String of string ]
type parameter_object = {
name : string;
in_ : parameter_location;
description : string option;
required : bool option;
deprecated : bool option;
allow_empty_value : bool option;
style : parameter_style option;
schema : Json_schema.schema Json_schema.or_ref option;
example : Json_schema.any option;
}
val make_parameter_object :
name:string ->
in_:parameter_location ->
?description:string ->
?required:bool ->
?deprecated:bool ->
?allow_empty_value:bool ->
?style:parameter_style ->
?schema:Json_schema.schema Json_schema.or_ref ->
?example:Json_schema.any ->
unit ->
parameter_object
val pp_parameter_object :
Ppx_deriving_runtime.Format.formatter ->
parameter_object ->
Ppx_deriving_runtime.unit
val show_parameter_object : parameter_object -> Ppx_deriving_runtime.string
val parameter_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
parameter_object
val yojson_of_parameter_object :
parameter_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type request_body_object = {
description : string option;
content : media_type_object Json_schema.map;
required : bool option;
}
val make_request_body_object :
?description:string ->
content:media_type_object Json_schema.map ->
?required:bool ->
unit ->
request_body_object
val pp_request_body_object :
Ppx_deriving_runtime.Format.formatter ->
request_body_object ->
Ppx_deriving_runtime.unit
val show_request_body_object :
request_body_object ->
Ppx_deriving_runtime.string
val request_body_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
request_body_object
val yojson_of_request_body_object :
request_body_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type security_scheme_object = {
type_ : string;
description : string option;
name : string option;
in_ : string option;
scheme : string option;
bearer_format : string option;
flows : Json_schema.any option;
openid_connect_url : string option;
}
val make_security_scheme_object :
type_:string ->
?description:string ->
?name:string ->
?in_:string ->
?scheme:string ->
?bearer_format:string ->
?flows:Json_schema.any ->
?openid_connect_url:string ->
unit ->
security_scheme_object
val pp_security_scheme_object :
Ppx_deriving_runtime.Format.formatter ->
security_scheme_object ->
Ppx_deriving_runtime.unit
val show_security_scheme_object :
security_scheme_object ->
Ppx_deriving_runtime.string
val security_scheme_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
security_scheme_object
val yojson_of_security_scheme_object :
security_scheme_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type callback_object = Json_schema.any
val pp_callback_object :
Ppx_deriving_runtime.Format.formatter ->
callback_object ->
Ppx_deriving_runtime.unit
val show_callback_object : callback_object -> Ppx_deriving_runtime.string
val callback_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
callback_object
val yojson_of_callback_object :
callback_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type components_object = {
schemas : Json_schema.schema Json_schema.or_ref Json_schema.map option;
responses : response_object Json_schema.or_ref Json_schema.map option;
parameters : parameter_object Json_schema.or_ref Json_schema.map option;
examples : example_object Json_schema.or_ref Json_schema.map option;
request_bodies : request_body_object Json_schema.or_ref Json_schema.map option;
headers : header_object Json_schema.or_ref Json_schema.map option;
security_schemes : security_scheme_object Json_schema.or_ref Json_schema.map
option;
links : link_object Json_schema.or_ref Json_schema.map option;
callbacks : callback_object Json_schema.or_ref Json_schema.map option;
}
val make_components_object :
?schemas:Json_schema.schema Json_schema.or_ref Json_schema.map ->
?responses:response_object Json_schema.or_ref Json_schema.map ->
?parameters:parameter_object Json_schema.or_ref Json_schema.map ->
?examples:example_object Json_schema.or_ref Json_schema.map ->
?request_bodies:request_body_object Json_schema.or_ref Json_schema.map ->
?headers:header_object Json_schema.or_ref Json_schema.map ->
?security_schemes:security_scheme_object Json_schema.or_ref Json_schema.map ->
?links:link_object Json_schema.or_ref Json_schema.map ->
?callbacks:callback_object Json_schema.or_ref Json_schema.map ->
unit ->
components_object
val pp_components_object :
Ppx_deriving_runtime.Format.formatter ->
components_object ->
Ppx_deriving_runtime.unit
val show_components_object : components_object -> Ppx_deriving_runtime.string
val components_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
components_object
val yojson_of_components_object :
components_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type info_object = {
title : string;
description : string option;
terms_of_service : string option;
contact : contact_object option;
license : license_object option;
version : string;
}
val make_info_object :
title:string ->
?description:string ->
?terms_of_service:string ->
?contact:contact_object ->
?license:license_object ->
version:string ->
unit ->
info_object
val pp_info_object :
Ppx_deriving_runtime.Format.formatter ->
info_object ->
Ppx_deriving_runtime.unit
val show_info_object : info_object -> Ppx_deriving_runtime.string
val info_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> info_object
val yojson_of_info_object : info_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
type operation_object = {
summary : string option;
description : string option;
external_docs : external_documentation_object option;
operation_id : string option;
parameters : parameter_object Json_schema.or_ref list option;
request_body : request_body_object Json_schema.or_ref option;
responses : responses_object;
callbacks : callback_object Json_schema.or_ref Json_schema.map option;
deprecated : bool option;
security : Json_schema.any option;
servers : server_object list option;
}
val make_operation_object :
?tags:string list ->
?summary:string ->
?description:string ->
?external_docs:external_documentation_object ->
?operation_id:string ->
?parameters:parameter_object Json_schema.or_ref list ->
?request_body:request_body_object Json_schema.or_ref ->
responses:responses_object ->
?callbacks:callback_object Json_schema.or_ref Json_schema.map ->
?deprecated:bool ->
?security:Json_schema.any ->
?servers:server_object list ->
unit ->
operation_object
val pp_operation_object :
Ppx_deriving_runtime.Format.formatter ->
operation_object ->
Ppx_deriving_runtime.unit
val show_operation_object : operation_object -> Ppx_deriving_runtime.string
val operation_object_of_yojson :
Ppx_yojson_conv_lib.Yojson.Safe.t ->
operation_object
val yojson_of_operation_object :
operation_object ->
Ppx_yojson_conv_lib.Yojson.Safe.t
type path_object = {
summary : string option;
description : string option;
get : operation_object option;
put : operation_object option;
post : operation_object option;
delete : operation_object option;
options : operation_object option;
head : operation_object option;
patch : operation_object option;
trace : operation_object option;
servers : server_object list option;
parameters : parameter_object Json_schema.or_ref list option;
}
val make_path_object :
?summary:string ->
?description:string ->
?get:operation_object ->
?put:operation_object ->
?post:operation_object ->
?delete:operation_object ->
?options:operation_object ->
?head:operation_object ->
?patch:operation_object ->
?trace:operation_object ->
?servers:server_object list ->
?parameters:parameter_object Json_schema.or_ref list ->
unit ->
path_object
val pp_path_object :
Ppx_deriving_runtime.Format.formatter ->
path_object ->
Ppx_deriving_runtime.unit
val show_path_object : path_object -> Ppx_deriving_runtime.string
val path_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> path_object
val yojson_of_path_object : path_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
type paths_object = path_object Json_schema.map
val paths_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> paths_object
val yojson_of_paths_object : paths_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
val pp_paths_object :
Ppx_deriving_runtime.Format.formatter ->
paths_object ->
Ppx_deriving_runtime.unit
val show_paths_object : paths_object -> Ppx_deriving_runtime.string
type tag_object = {
name : string;
description : string option;
external_docs : external_documentation_object option;
}
val make_tag_object :
name:string ->
?description:string ->
?external_docs:external_documentation_object ->
unit ->
tag_object
val pp_tag_object :
Ppx_deriving_runtime.Format.formatter ->
tag_object ->
Ppx_deriving_runtime.unit
val show_tag_object : tag_object -> Ppx_deriving_runtime.string
val tag_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> tag_object
val yojson_of_tag_object : tag_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
type t = {
openapi : string;
info : info_object;
servers : server_object list option;
paths : paths_object;
components : components_object option;
security : Json_schema.any option;
external_docs : external_documentation_object option;
}
val make :
openapi:string ->
info:info_object ->
?servers:server_object list ->
paths:paths_object ->
?components:components_object ->
?security:Json_schema.any ->
?tags:tag_object list ->
?external_docs:external_documentation_object ->
unit ->
t
val pp :
Ppx_deriving_runtime.Format.formatter ->
t ->
Ppx_deriving_runtime.unit
val show : t -> Ppx_deriving_runtime.string
val t_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> t
val yojson_of_t : t -> Ppx_yojson_conv_lib.Yojson.Safe.t