balsoft/ligo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: fix the RPC and error docs intros

Browse Source
This commit is contained in:
Benjamin Canou 2018-03-18 20:27:58 +01:00
parent 73ba0a3fb5
commit fc1ea36a62
3 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/doc_gen/errors/error_doc.ml
View File

@ -230,8 +230,9 @@ let () =
print_script ppf ; print_script ppf ;
fprintf ppf "This document references possible errors that can come\ fprintf ppf
from RPC calls. It is generated from the OCaml source\ "This document references possible errors that can come \
from RPC calls. It is generated from the OCaml source \
code (master branch).@\n@\n" ; code (master branch).@\n@\n" ;
(* Body *) (* Body *)

4
docs/doc_gen/rpcs/rpc_doc.ml
View File

@ -299,9 +299,9 @@ let pp_print_html_tabs fmt { path ; description ; input ; output ; _ (* example
fprintf fmt "%a" (pp_print_html_tab_button ~default:true ~shortlabel:"descr" ~content:"Description") path; fprintf fmt "%a" (pp_print_html_tab_button ~default:true ~shortlabel:"descr" ~content:"Description") path;
(match input with (match input with
| Some _ -> | Some _ ->
fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"input" ~content:"Input schema") path; fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"input" ~content:"Input format") path;
| None -> ()); | None -> ());
fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"output" ~content:"Output schema") path; fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"output" ~content:"Output format") path;
(* (match example with (* (match example with
* | Some _ -> * | Some _ ->
* fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"example" ~content:"Example") path; * fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"example" ~content:"Example") path;

19
docs/doc_gen/rpcs/usage.rst
View File

@ -1,12 +1,15 @@
This document contains the list of RPC services provided by the Tezos
node. It is generated from the OCaml source code (master branch).
Usage Usage
***** *****
In order to interact with a Tezos node, you may use RPC calls through the In order to interact with a Tezos node, you may use RPC calls through the
client using this command ``tezos-client rpc call <url>``. client using this command ``tezos-admin-client rpc call <url>``.
For instance, if you wish to request the current balance of a given For instance, if you wish to request the current balance of a given
block and contract, you can call the associated RPC via the command : block and contract, you can call the associated RPC via the command :
``$ tezos-client rpc call ``$ tezos-admin-client rpc call
/blocks/<block_id>/proto/context/contracts/<contract_id>/balance``. /blocks/<block_id>/proto/context/contracts/<contract_id>/balance``.
A RPC may takes an *input* and generates an *output* both in JSON A RPC may takes an *input* and generates an *output* both in JSON
@ -14,4 +17,14 @@ format. For example, the previous RPC call, that does not require an
input, would display on the standard output : ``{ "balance": input, would display on the standard output : ``{ "balance":
"4000000000000" }``. When calling a RPC that requires an input "4000000000000" }``. When calling a RPC that requires an input
through command-line, you will be prompted to provide the JSON input through command-line, you will be prompted to provide the JSON input
in your default configured text editor. in your default configured text editor. Alternatively, you can provide
the JSON input using command
``$ tezos-admin-client rpc call <url> with <JSON>``. Don't forget to quote
the JSON according to your shell rules.
You can also obtain the list of RPCs on the command line with
``tezos-admin-client rpc list /``, and the description of each service
using ``tezos-admin-client rpc format <url>``.
Of course, you can use your standard HTTP tool or library as well to
perform all these tasks.