package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Resto.Description end

Service directory description

type request = Resto.Description.request = {
  1. recurse : bool;
}
type '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;
}
and path_item = Resto.Description.path_item =
  1. | PStatic of string
  2. | PDynamic of Resto.Arg.descr
  3. | PDynamicTail of Resto.Arg.descr
and query_item = Resto.Description.query_item = {
  1. name : string;
  2. description : string option;
  3. kind : query_kind;
}
and 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
type 'schema directory = 'schema Resto.Description.directory =
  1. | Empty
  2. | Static of 'schema static_directory
  3. | Dynamic of string option
and 'schema static_directory = 'schema Resto.Description.static_directory = {
  1. services : 'schema service Resto.MethMap.t;
  2. subdirs : 'schema static_subdirectories option;
}
and 'schema static_subdirectories = 'schema Resto.Description.static_subdirectories =
  1. | Suffixes of 'schema directory Resto.StringMap.t
  2. | Arg of Resto.Arg.descr * 'schema directory
val pp_print_directory : Format.formatter -> 'schema directory -> unit
val 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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct