package tezos-openapi

  1. Overview
  2. Docs

Module Tezos_openapi.ApiSource

Sourceval fail : ('a, unit, string, 'b) format4 -> 'a
Sourcetype arg = {
  1. id : string;
  2. name : string;
  3. descr : string option;
}
Sourcetype 'a tree =
  1. | Static of 'a static
  2. | Dynamic of Json.t
Sourceand 'a static = {
  1. get_service : 'a option;
  2. post_service : 'a option;
  3. put_service : 'a option;
  4. delete_service : 'a option;
  5. patch_service : 'a option;
  6. subdirs : 'a subdirs option;
}
Sourceand 'a subdirs =
  1. | Suffixes of 'a suffix list
  2. | Dynamic_dispatch of {
    1. arg : arg;
    2. tree : 'a tree;
    }
Sourceand 'a suffix = {
  1. name : string;
  2. tree : 'a tree;
}
Sourceval opt_mandatory : string -> Json.t -> 'a option -> 'a
Sourceval parse_arg : Json.t -> arg
Sourceval parse_tree : Json.t -> Json.t tree
Sourceval parse_subdirs : Json.t -> Json.t subdirs
Sourceval parse_suffix : Json.t -> Json.t suffix
Sourcetype path_item =
  1. | PI_static of string
  2. | PI_dynamic of arg
Sourceval show_path_item : path_item -> string
Sourcetype path = path_item list
Sourceval show_path : path_item list -> string
Sourcetype 'a endpoint = {
  1. path : path;
  2. get : 'a option;
  3. post : 'a option;
  4. put : 'a option;
  5. delete : 'a option;
  6. patch : 'a option;
}
Sourceval flatten_tree : path_item list -> 'a endpoint list -> 'a tree -> 'a endpoint list
Sourceval flatten_static : path_item list -> 'a endpoint list -> 'a static -> 'a endpoint list
Sourceval flatten_subdirs : path_item list -> 'a endpoint list -> 'a subdirs -> 'a endpoint list
Sourceval flatten_suffix : path_item list -> 'a endpoint list -> 'a suffix -> 'a endpoint list
Sourceval flatten : 'a tree -> 'a endpoint list
Sourcetype schemas = {
  1. json_schema : Json.t;
  2. binary_schema : Json.t;
}
Sourcetype query_parameter_kind =
  1. | Optional of {
    1. name : string;
    }
  2. | Multi of {
    1. name : string;
    }
  3. | Single of {
    1. name : string;
    }
  4. | Flag
Sourcetype query_parameter = {
  1. id : string option;
  2. name : string;
  3. description : string option;
  4. kind : query_parameter_kind;
}
Sourcetype service = {
  1. meth : Method.t;
  2. path : path_item list;
  3. description : string;
  4. query : query_parameter list;
  5. input : schemas option;
  6. output : schemas option;
  7. error : schemas option;
}
Sourceval parse_schemas : Json.t -> schemas
Sourceval parse_path_item : Json.t -> path_item
Sourceval parse_path : Json.t -> path
Sourceval parse_query_parameter : Json.t -> query_parameter
Sourceval parse_service : Json.t -> service
Sourceval map_tree : ('a -> 'b) -> 'a tree -> 'b tree
Sourceval map_static : ('a -> 'b) -> 'a static -> 'b static
Sourceval map_subdirs : ('a -> 'b) -> 'a subdirs -> 'b subdirs
Sourceval map_suffix : ('a -> 'b) -> 'a suffix -> 'b suffix
Sourceval parse_services : Json.t tree -> service tree