tezos-openapi 20.1 · OCaml Package

val fail : ('a, unit, string, 'b) format4 -> 'a

type arg = {

id : string;
name : string;
descr : string option;

}

type 'a tree =

| Static of 'a static
| Dynamic of Json.t

and 'a static = {

get_service : 'a option;
post_service : 'a option;
put_service : 'a option;
delete_service : 'a option;
patch_service : 'a option;
subdirs : 'a subdirs option;

}

and 'a subdirs =

| Suffixes of 'a suffix list
| Dynamic_dispatch of {
1. arg : arg;
2. tree : 'a tree;
}

and 'a suffix = {

name : string;
tree : 'a tree;

}

val opt_mandatory : string -> Json.t -> 'a option -> 'a

val parse_arg : Json.t -> arg

val parse_tree : Json.t -> Json.t tree

val parse_subdirs : Json.t -> Json.t subdirs

val parse_suffix : Json.t -> Json.t suffix

type path_item =

| PI_static of string
| PI_dynamic of arg

val show_path_item : path_item -> string

type path = path_item list

val show_path : path_item list -> string

type 'a endpoint = {

path : path;
get : 'a option;
post : 'a option;
put : 'a option;
delete : 'a option;
patch : 'a option;

}

val flatten_tree : 
  path_item list ->
  'a endpoint list ->
  'a tree ->
  'a endpoint list

val flatten_static : 
  path_item list ->
  'a endpoint list ->
  'a static ->
  'a endpoint list

val flatten_subdirs : 
  path_item list ->
  'a endpoint list ->
  'a subdirs ->
  'a endpoint list

val flatten_suffix : 
  path_item list ->
  'a endpoint list ->
  'a suffix ->
  'a endpoint list

val flatten : 'a tree -> 'a endpoint list

type schemas = {

json_schema : Json.t;
binary_schema : Json.t;

}

type query_parameter_kind =

| Optional of {
1. name : string;
}
| Multi of {
1. name : string;
}
| Single of {
1. name : string;
}
| Flag

type query_parameter = {

id : string option;
name : string;
description : string option;
kind : query_parameter_kind;

}

type service = {

meth : Method.t;
path : path_item list;
description : string;
query : query_parameter list;
input : schemas option;
output : schemas option;
error : schemas option;

}

val parse_schemas : Json.t -> schemas

val parse_path_item : Json.t -> path_item

val parse_path : Json.t -> path

val parse_query_parameter : Json.t -> query_parameter

val parse_service : Json.t -> service

val map_tree : ('a -> 'b) -> 'a tree -> 'b tree

val map_static : ('a -> 'b) -> 'a static -> 'b static

val map_subdirs : ('a -> 'b) -> 'a subdirs -> 'b subdirs

val map_suffix : ('a -> 'b) -> 'a suffix -> 'b suffix

val parse_services : Json.t tree -> service tree

package tezos-openapi