Browse Source

Fixed doc format and rebase

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
bump-pyln-proto
Vincenzo Palazzo 4 years ago
committed by Rusty Russell
parent
commit
d1c2c5c792
  1. 15
      doc/lightning-listconfigs.7
  2. 10
      doc/lightning-listconfigs.7.md

15
doc/lightning-listconfigs.7

@ -15,7 +15,9 @@ The \fBlistconfigs\fR teh RPC command to list all configuration options, or with
{ {
"id": 82, "id": 82,
"method": "listconfigs", "method": "listconfigs",
"params": {} "params": {
"config": "network"
}
} }
.RE .RE
@ -28,7 +30,7 @@ On success, an object with the following proprieties is returned:
.IP \[bu] .IP \[bu]
\fI# version\fR: A string that rappresents the version of node\. \fI# version\fR: A string that rappresents the version of node\.
.IP \[bu] .IP \[bu]
\fIlightning-di\fR: A string that rappresents the work dir of the node\. \fIlightning-dir\fR: A string that rappresents the work dir of the node\.
.IP \[bu] .IP \[bu]
\fInetwork\fR: A string that rappresents the network (e\.g: bitcoin)\. \fInetwork\fR: A string that rappresents the network (e\.g: bitcoin)\.
.IP \[bu] .IP \[bu]
@ -115,17 +117,16 @@ On success, an object with the following proprieties is returned:
.IP \[bu] .IP \[bu]
\fIlog-level\fR: A string that rappresent the level of log\. \fIlog-level\fR: A string that rappresent the level of log\.
.IP \[bu] .IP \[bu]
\fIlog-prefix\fR: A string that rappresent the log prefix\.i
\fIlog-prefix\fR: A string that rappresent the log prefix\. .RE
On failure, one of the following error codes may be returned:
On failure, one of the following error codes may be returned:
.RS
.IP \[bu] .IP \[bu]
-32602: Error in given parameters or field with \fIconfig\fR name doesn't exist\. -32602: Error in given parameters or field with \fIconfig\fR name doesn't exist\.
.RE .RE
.SH EXAMPLE JSON RESPONSE .SH EXAMPLE JSON RESPONSE
.nf .nf

10
doc/lightning-listconfigs.7.md

@ -18,7 +18,9 @@ EXAMPLE JSON REQUEST
{ {
"id": 82, "id": 82,
"method": "listconfigs", "method": "listconfigs",
"params": {} "params": {
"config": "network"
}
} }
``` ```
@ -28,7 +30,7 @@ RETURN VALUE
On success, an object with the following proprieties is returned: On success, an object with the following proprieties is returned:
- *# version*: A string that rappresents the version of node. - *# version*: A string that rappresents the version of node.
- *lightning-di*: A string that rappresents the work dir of the node. - *lightning-dir*: A string that rappresents the work dir of the node.
- *network*: A string that rappresents the network (e.g: bitcoin). - *network*: A string that rappresents the network (e.g: bitcoin).
- *allow-deprecated-apis*: A boolean value that rappresent if the deprecated api are avaible on the node. - *allow-deprecated-apis*: A boolean value that rappresent if the deprecated api are avaible on the node.
- *rpc-file*: A string that rappresent the location of the rpc file. - *rpc-file*: A string that rappresent the location of the rpc file.
@ -70,7 +72,9 @@ On success, an object with the following proprieties is returned:
- *encrypted-hsm*: A boolean value that rappresent if the wallet is encrypted. - *encrypted-hsm*: A boolean value that rappresent if the wallet is encrypted.
- *rpc-file-mode*: A string that rappresent the value rpc-file-mode. - *rpc-file-mode*: A string that rappresent the value rpc-file-mode.
- *log-level*: A string that rappresent the level of log. - *log-level*: A string that rappresent the level of log.
- *log-prefix*: A string that rappresent the log prefix. - *log-prefix*: A string that rappresent the log prefix.i
On failure, one of the following error codes may be returned: On failure, one of the following error codes may be returned:
- -32602: Error in given parameters or field with *config* name doesn't exist. - -32602: Error in given parameters or field with *config* name doesn't exist.

Loading…
Cancel
Save