package tezos-rpc

  1. Overview
  2. Docs

Module Tezos_rpc.DescriptionSource

include module type of struct include Resto.Description end
Sourcetype request = Resto.Description.request = {
  1. recurse : bool;
}
Sourcetype 'schema service = 'schema Resto.Description.service = {
  1. description : string option;
  2. path : path_item list;
  3. meth : Resto.meth;
  4. query : query_item list;
  5. input : 'schema Lazy.t option;
  6. output : 'schema Lazy.t;
  7. error : 'schema Lazy.t;
}
Sourceand path_item = Resto.Description.path_item =
  1. | PStatic of string
  2. | PDynamic of Resto.Arg.descr
  3. | PDynamicTail of Resto.Arg.descr
Sourceand query_item = Resto.Description.query_item = {
  1. name : string;
  2. description : string option;
  3. kind : query_kind;
}
Sourceand query_kind = Resto.Description.query_kind =
  1. | Single of Resto.Arg.descr
  2. | Optional of Resto.Arg.descr
  3. | Flag
  4. | Multi of Resto.Arg.descr
Sourcetype 'schema directory = 'schema Resto.Description.directory =
  1. | Empty
  2. | Static of 'schema static_directory
  3. | Dynamic of string option
Sourceand 'schema static_directory = 'schema Resto.Description.static_directory = {
  1. services : 'schema service Resto.MethMap.t;
  2. subdirs : 'schema static_subdirectories option;
}
Sourceand 'schema static_subdirectories = 'schema Resto.Description.static_subdirectories =
  1. | Suffixes of 'schema directory Resto.StringMap.t
  2. | Arg of Resto.Arg.descr * 'schema directory
Sourceval pp_print_directory : Format.formatter -> 'schema directory -> unit
Sourceval describe : Tezos_rpc__.RPC_context.simple -> ?recurse:bool -> string list -> (Data_encoding.json_schema * Data_encoding.Binary_schema.t) directory Tezos_error_monad.Error_monad.tzresult Lwt.t