openapi_router 0.1.0 · OCaml Package

type contact_object = {

name : string option;
url : string option;
email : string option;

}

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

type license_object = {

name : string;
url : string option;

}

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

type server_variable_object = {

enum : string list option;
default : string;
description : string option;

}

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

type external_documentation_object = {

description : string option;
url : string;

}

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 : (string * server_variable_object) list option;

}

val make_server_object : 
  url:string ->
  ?description:string ->
  ?variables:(string * server_variable_object) list ->
  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 : (string * Yojson.Safe.t) list option;
request_body : Yojson.Safe.t option;
description : string option;
server : server_object option;

}

val make_link_object : 
  ?operation_ref:string ->
  ?operation_id:string ->
  ?parameters:(string * Yojson.Safe.t) list ->
  ?request_body:Yojson.Safe.t ->
  ?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

type header_object = {

description : string option;
required : bool option;
deprecated : bool option;
allow_empty_value : bool option;

}

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 : Yojson.Safe.t option;
externalValue : string option;

}

val make_example_object : 
  ?summary:string ->
  ?description:string ->
  ?value:Yojson.Safe.t ->
  ?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 : Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref option;
example : Yojson.Safe.t option;
examples : (string * example_object Openapi_router__.Json_schema.or_ref) list option;
encoding : (string * Yojson.Safe.t) list option;

}

val make_media_type_object : 
  ?schema:
    Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref ->
  ?example:Yojson.Safe.t ->
  ?examples:(string * example_object Openapi_router__.Json_schema.or_ref) list ->
  ?encoding:(string * Yojson.Safe.t) list ->
  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 : (string * header_object Openapi_router__.Json_schema.or_ref) list option;
content : (string * media_type_object) list option;
links : (string * link_object Openapi_router__.Json_schema.or_ref) list option;

}

val make_response_object : 
  description:string ->
  ?headers:(string * header_object Openapi_router__.Json_schema.or_ref) list ->
  ?content:(string * media_type_object) list ->
  ?links:(string * link_object Openapi_router__.Json_schema.or_ref) list ->
  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 =
  (string * response_object Openapi_router__.Json_schema.or_ref) list

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

type parameter_location =

| Query
| Header
| Path
| Cookie

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 ]

type parameter_style =

| Simple
| Form

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 : Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref option;
example : Yojson.Safe.t option;

}

val make_parameter_object : 
  name:string ->
  in_:parameter_location ->
  ?description:string ->
  ?required:bool ->
  ?deprecated:bool ->
  ?allow_empty_value:bool ->
  ?style:parameter_style ->
  ?schema:
    Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref ->
  ?example:Yojson.Safe.t ->
  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 : (string * media_type_object) list;
required : bool option;

}

val make_request_body_object : 
  ?description:string ->
  content:(string * media_type_object) list ->
  ?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 : Yojson.Safe.t 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:Yojson.Safe.t ->
  ?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 = Yojson.Safe.t

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 : (string * Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref) list option;
responses : (string * response_object Openapi_router__.Json_schema.or_ref) list option;
parameters : (string * parameter_object Openapi_router__.Json_schema.or_ref) list option;
examples : (string * example_object Openapi_router__.Json_schema.or_ref) list option;
request_bodies : (string * request_body_object Openapi_router__.Json_schema.or_ref) list option;
headers : (string * header_object Openapi_router__.Json_schema.or_ref) list option;
security_schemes : (string * security_scheme_object Openapi_router__.Json_schema.or_ref) list option;
links : (string * link_object Openapi_router__.Json_schema.or_ref) list option;
callbacks : (string * callback_object Openapi_router__.Json_schema.or_ref) list option;

}

val make_components_object : 
  ?schemas:
    (string
     * Openapi_router__.Json_schema.schema Openapi_router__.Json_schema.or_ref)
      list ->
  ?responses:
    (string * response_object Openapi_router__.Json_schema.or_ref) list ->
  ?parameters:
    (string * parameter_object Openapi_router__.Json_schema.or_ref) list ->
  ?examples:(string * example_object Openapi_router__.Json_schema.or_ref) list ->
  ?request_bodies:
    (string * request_body_object Openapi_router__.Json_schema.or_ref) list ->
  ?headers:(string * header_object Openapi_router__.Json_schema.or_ref) list ->
  ?security_schemes:
    (string * security_scheme_object Openapi_router__.Json_schema.or_ref) list ->
  ?links:(string * link_object Openapi_router__.Json_schema.or_ref) list ->
  ?callbacks:
    (string * callback_object Openapi_router__.Json_schema.or_ref) list ->
  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 = {

tags : string list option;
summary : string option;
description : string option;
external_docs : external_documentation_object option;
operation_id : string option;
parameters : parameter_object Openapi_router__.Json_schema.or_ref list option;
request_body : request_body_object Openapi_router__.Json_schema.or_ref option;
responses : responses_object;
callbacks : (string * callback_object Openapi_router__.Json_schema.or_ref) list option;
deprecated : bool option;
security : Yojson.Safe.t 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 Openapi_router__.Json_schema.or_ref list ->
  ?request_body:request_body_object Openapi_router__.Json_schema.or_ref ->
  responses:responses_object ->
  ?callbacks:
    (string * callback_object Openapi_router__.Json_schema.or_ref) list ->
  ?deprecated:bool ->
  ?security:Yojson.Safe.t ->
  ?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 Openapi_router__.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 Openapi_router__.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 = (string * path_object) list

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

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

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 : Yojson.Safe.t option;
tags : tag_object list 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:Yojson.Safe.t ->
  ?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

package openapi_router