tezos-rpc

Tezos: library of auto-documented RPCs (service and hierarchy descriptions)
Library tezos-rpc
Module Tezos_rpc . RPC_description
include module type of struct include Resto.Description end

Service directory description

type request = Resto.Description.request = {
recurse : bool;
}
type 'schema service = 'schema Resto.Description.service = {
description : string option;
path : path_item list;
meth : Resto.meth;
query : query_item list;
input : 'schema Lazy.t option;
output : 'schema Lazy.t;
error : 'schema Lazy.t;
}
and path_item = Resto.Description.path_item =
| PStatic of string
| PDynamic of Resto.Arg.descr
| PDynamicTail of Resto.Arg.descr
and query_item = Resto.Description.query_item = {
name : string;
description : string option;
kind : query_kind;
}
and query_kind = Resto.Description.query_kind =
| Single of Resto.Arg.descr
| Optional of Resto.Arg.descr
| Flag
| Multi of Resto.Arg.descr
type 'schema directory = 'schema Resto.Description.directory =
| Empty
| Static of 'schema static_directory
| Dynamic of string option
and 'schema static_directory = 'schema Resto.Description.static_directory = {
services : 'schema service Resto.MethMap.t;
subdirs : 'schema static_subdirectories option;
}
and 'schema static_subdirectories = 'schema Resto.Description.static_subdirectories =
| Suffixes of 'schema directory Resto.StringMap.t
| Arg of Resto.Arg.descr * 'schema directory
val pp_print_directory : Format.formatter -> 'schema directory -> unit