package openapi

  1. Overview
  2. Docs

Module Openapi.SpecSource

Sourcetype contact_object = {
  1. name : string option;
  2. url : string option;
  3. email : string option;
}
Sourceval make_contact_object : ?name:string -> ?url:string -> ?email:string -> unit -> contact_object
Sourcetype license_object = {
  1. name : string;
  2. url : string option;
}
Sourceval make_license_object : name:string -> ?url:string -> unit -> license_object
Sourcetype server_variable_object = {
  1. enum : string list option;
  2. default : string;
  3. description : string option;
}
Sourceval make_server_variable_object : ?enum:string list -> default:string -> ?description:string -> unit -> server_variable_object
Sourceval show_server_variable_object : server_variable_object -> Ppx_deriving_runtime.string
Sourceval server_variable_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> server_variable_object
Sourceval yojson_of_server_variable_object : server_variable_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype external_documentation_object = {
  1. description : string option;
  2. url : string;
}
Sourceval make_external_documentation_object : ?description:string -> url:string -> unit -> external_documentation_object
Sourceval show_external_documentation_object : external_documentation_object -> Ppx_deriving_runtime.string
Sourceval external_documentation_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> external_documentation_object
Sourceval yojson_of_external_documentation_object : external_documentation_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype server_object = {
  1. url : string;
  2. description : string option;
  3. variables : server_variable_object Json_schema.map option;
}
Sourceval make_server_object : url:string -> ?description:string -> ?variables:server_variable_object Json_schema.map -> unit -> server_object
Sourcetype header_object = {
  1. description : string option;
  2. required : bool option;
  3. deprecated : bool option;
  4. allow_empty_value : bool option;
}
Sourceval make_header_object : ?description:string -> ?required:bool -> ?deprecated:bool -> ?allow_empty_value:bool -> unit -> header_object
Sourcetype example_object = {
  1. summary : string option;
  2. description : string option;
  3. value : Json_schema.any option;
  4. externalValue : string option;
}
Sourceval make_example_object : ?summary:string -> ?description:string -> ?value:Json_schema.any -> ?externalValue:string -> unit -> example_object
Sourcetype media_type_object = {
  1. schema : Json_schema.schema Json_schema.or_ref option;
  2. example : Json_schema.any option;
  3. examples : example_object Json_schema.or_ref Json_schema.map option;
  4. encoding : Json_schema.any Json_schema.map option;
}
Sourceval media_type_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> media_type_object
Sourceval yojson_of_media_type_object : media_type_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype response_object = {
  1. description : string;
  2. headers : header_object Json_schema.or_ref Json_schema.map option;
  3. content : media_type_object Json_schema.map option;
}
Sourceval 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
Sourceval response_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> response_object
Sourceval yojson_of_response_object : response_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourceval responses_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> responses_object
Sourceval yojson_of_responses_object : responses_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype parameter_location =
  1. | Query
  2. | Header
  3. | Path
  4. | Cookie
Sourceval show_parameter_location : parameter_location -> Ppx_deriving_runtime.string
Sourceval parameter_location_of_yojson : Yojson.Safe.t -> parameter_location
Sourceval yojson_of_parameter_location : parameter_location -> [> `String of string ]
Sourcetype parameter_style =
  1. | Simple
  2. | Form
Sourceval parameter_style_of_yojson : Yojson.Safe.t -> parameter_style
Sourceval yojson_of_parameter_style : parameter_style -> [> `String of string ]
Sourcetype parameter_object = {
  1. name : string;
  2. in_ : parameter_location;
  3. description : string option;
  4. required : bool option;
  5. deprecated : bool option;
  6. allow_empty_value : bool option;
  7. style : parameter_style option;
  8. schema : Json_schema.schema Json_schema.or_ref option;
  9. example : Json_schema.any option;
}
Sourceval 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
Sourceval parameter_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> parameter_object
Sourceval yojson_of_parameter_object : parameter_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype request_body_object = {
  1. description : string option;
  2. content : media_type_object Json_schema.map;
  3. required : bool option;
}
Sourceval make_request_body_object : ?description:string -> content:media_type_object Json_schema.map -> ?required:bool -> unit -> request_body_object
Sourceval pp_request_body_object : Ppx_deriving_runtime.Format.formatter -> request_body_object -> Ppx_deriving_runtime.unit
Sourceval show_request_body_object : request_body_object -> Ppx_deriving_runtime.string
Sourceval request_body_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> request_body_object
Sourceval yojson_of_request_body_object : request_body_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype security_scheme_object = {
  1. type_ : string;
  2. description : string option;
  3. name : string option;
  4. in_ : string option;
  5. scheme : string option;
  6. bearer_format : string option;
  7. flows : Json_schema.any option;
  8. openid_connect_url : string option;
}
Sourceval 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
Sourceval show_security_scheme_object : security_scheme_object -> Ppx_deriving_runtime.string
Sourceval security_scheme_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> security_scheme_object
Sourceval yojson_of_security_scheme_object : security_scheme_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype callback_object = Json_schema.any
Sourceval callback_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> callback_object
Sourceval yojson_of_callback_object : callback_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourceval components_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> components_object
Sourceval yojson_of_components_object : components_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype info_object = {
  1. title : string;
  2. description : string option;
  3. terms_of_service : string option;
  4. contact : contact_object option;
  5. license : license_object option;
  6. version : string;
}
Sourceval make_info_object : title:string -> ?description:string -> ?terms_of_service:string -> ?contact:contact_object -> ?license:license_object -> version:string -> unit -> info_object
Sourcetype operation_object = {
  1. tags : string list option;
  2. summary : string option;
  3. description : string option;
  4. external_docs : external_documentation_object option;
  5. operation_id : string option;
  6. parameters : parameter_object Json_schema.or_ref list option;
  7. request_body : request_body_object Json_schema.or_ref option;
  8. responses : responses_object;
  9. callbacks : callback_object Json_schema.or_ref Json_schema.map option;
  10. deprecated : bool option;
  11. security : Json_schema.any option;
  12. servers : server_object list option;
}
Sourceval 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
Sourceval operation_object_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> operation_object
Sourceval yojson_of_operation_object : operation_object -> Ppx_yojson_conv_lib.Yojson.Safe.t
Sourcetype path_object = {
  1. summary : string option;
  2. description : string option;
  3. get : operation_object option;
  4. put : operation_object option;
  5. post : operation_object option;
  6. delete : operation_object option;
  7. options : operation_object option;
  8. head : operation_object option;
  9. patch : operation_object option;
  10. trace : operation_object option;
  11. servers : server_object list option;
  12. parameters : parameter_object Json_schema.or_ref list option;
}
Sourceval 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
Sourcetype tag_object = {
  1. name : string;
  2. description : string option;
  3. external_docs : external_documentation_object option;
}
Sourceval make_tag_object : name:string -> ?description:string -> ?external_docs:external_documentation_object -> unit -> tag_object
Sourcetype t = {
  1. openapi : string;
  2. info : info_object;
  3. servers : server_object list option;
  4. paths : paths_object;
  5. components : components_object option;
  6. security : Json_schema.any option;
  7. tags : tag_object list option;
  8. external_docs : external_documentation_object option;
}
Sourceval 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