package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Library
Module
Module type
Parameter
Class
Class type
type contact_object = {
  1. oco_name : string option;
  2. oco_url : string option;
  3. oco_email : string option;
}
type license_object = {
  1. oli_name : string;
  2. oli_url : string option;
}
type openapi_info = {
  1. oin_title : string;
  2. oin_description : string option;
  3. oin_terms : string option;
  4. oin_contact : contact_object option;
  5. oin_license : license_object option;
  6. oin_version : string;
}
type server_variable_object = {
  1. osv_enum : string list option;
  2. osv_default : string;
  3. osv_description : string option;
}
type server_object = {
  1. osr_url : string;
  2. osr_description : string option;
  3. osr_variables : (string * server_variable_object) list option;
}
type param_object = {
  1. opm_name : string;
  2. opm_in : string;
  3. opm_description : string option;
  4. opm_required : bool;
  5. opm_deprecated : bool option;
  6. opm_allow_empty : bool option;
  7. opm_style : string option;
  8. opm_example : Json_repr.any option;
  9. opm_schema : Json_repr.ezjsonm option;
}
type encoding_object = {
  1. oenc_content_type : string option;
  2. oenc_headers : (string * param_object) list option;
  3. oenc_style : string option;
  4. oenc_explode : bool option;
  5. oenc_allow_reserved : bool option;
}
type media_type_object = {
  1. omt_schema : Json_repr.ezjsonm option;
  2. omt_example : Json_repr.any option;
  3. omt_encoding : encoding_object option;
}
type response_object = {
  1. ors_description : string;
  2. ors_headers : (string * param_object) list option;
  3. ors_content : (string * media_type_object) list option;
}
type external_doc_object = {
  1. oed_description : string option;
  2. oed_url : string;
}
type request_object = {
  1. orq_description : string option;
  2. orq_content : (string * media_type_object) list;
  3. orq_required : bool option;
}
type operation_object = {
  1. opt_tags : string list option;
  2. opt_summary : string option;
  3. opt_description : string option;
  4. opt_external : external_doc_object option;
  5. opt_id : string option;
  6. opt_params : param_object list option;
  7. opt_request : request_object option;
  8. opt_responses : (string * response_object) list;
  9. opt_deprecated : bool option;
  10. opt_security : EzAPI.Security.scheme list option;
  11. opt_servers : server_object list option;
}
type path_item = {
  1. opa_ref : string option;
  2. opa_summary : string option;
  3. opa_description : string option;
  4. opa_method : string;
  5. opa_operation : operation_object;
  6. opa_servers : server_object list option;
  7. opa_params : param_object list option;
}
type example_object = {
  1. oex_summary : string option;
  2. oex_description : string option;
  3. oex_value : Json_repr.any option;
  4. oex_external : string option;
}
type security_scheme_object = {
  1. osc_type : string;
  2. osc_description : string option;
  3. osc_name : string option;
  4. osc_in : string option;
  5. osc_scheme : string option;
  6. osc_format : string option;
  7. osc_connect_url : string option;
}
type components_object = {
  1. ocm_schemas : (string * Json_repr.any) list option;
  2. ocm_responses : (string * response_object) list option;
  3. ocm_parameters : (string * param_object) list option;
  4. ocm_examples : (string * example_object) list option;
  5. ocm_requests : (string * request_object) list option;
  6. ocm_headers : (string * param_object) list option;
  7. ocm_security : EzAPI.Security.scheme list option;
}
type openapi_object = {
  1. oa_version : string;
  2. oa_info : openapi_info;
  3. oa_servers : server_object list option;
  4. oa_paths : (string * path_item) list;
  5. oa_components : components_object option;
  6. oa_security : EzAPI.Security.scheme list option;
  7. oa_tags : string list option;
  8. oa_external : external_doc_object option;
}