Browse Source

doc: update and fix listinvoices output in man page.

1. The field *expiry_time* is actually called *expires_at*.
2. The description field is missing.
3. The bolt11 field is missing.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ppa
Rusty Russell 4 years ago
parent
commit
8f37437a14
  1. 10
      doc/lightning-listinvoices.7
  2. 8
      doc/lightning-listinvoices.7.md

10
doc/lightning-listinvoices.7

@ -19,11 +19,13 @@ query parameters can be used at once\.
.SH RETURN VALUE .SH RETURN VALUE
On success, an array \fIinvoices\fR of objects is returned\. Each object contains On success, an array \fIinvoices\fR of objects is returned\. Each object contains
\fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or \fIexpired\fR), \fIlabel\fR, \fIdescription\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or \fIexpired\fR),
\fIpayment_preimage\fR (for paid invoices), and \fIexpiry_time\fR (a UNIX \fIpayment_preimage\fR (for paid invoices), and \fIexpires_at\fR (a UNIX
timestamp)\. If the \fImsatoshi\fR argument to \fBlightning-invoice\fR(7) was not "any", timestamp)\. If the \fImsatoshi\fR argument to \fBlightning-invoice\fR(7) was not "any",
there will be an \fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same there will be an \fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same
number ending in \fImsat\fR\. If the invoice \fIstatus\fR is \fIpaid\fR, there will be a number ending in \fImsat\fR\. If the invoice was created with a bolt11 string,
there will be a \fIbolt11\fR field\.
If the invoice \fIstatus\fR is \fIpaid\fR, there will be a
\fIpay_index\fR field and an \fImsatoshi_received\fR field (which may be slightly \fIpay_index\fR field and an \fImsatoshi_received\fR field (which may be slightly
greater than \fImsatoshi\fR as some overpaying is permitted to allow clients to greater than \fImsatoshi\fR as some overpaying is permitted to allow clients to
obscure payment paths); there will also be an \fIamount_received_msat\fR field obscure payment paths); there will also be an \fIamount_received_msat\fR field
@ -41,4 +43,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:24dc46a53eed1dd689d7fb371a3da52242f306126d54bba3d8c6ba5a75b6b795 \" SHA256STAMP:3d3cef4fa52635fa5c515959718e017173c3fffdc32ca7066fea3b82cf93758d

8
doc/lightning-listinvoices.7.md

@ -21,11 +21,13 @@ RETURN VALUE
------------ ------------
On success, an array *invoices* of objects is returned. Each object contains On success, an array *invoices* of objects is returned. Each object contains
*label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*), *label*, *description*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*),
*payment\_preimage* (for paid invoices), and *expiry\_time* (a UNIX *payment\_preimage* (for paid invoices), and *expires\_at* (a UNIX
timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any", timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any",
there will be an *msatoshi* field as a number, and *amount\_msat* as the same there will be an *msatoshi* field as a number, and *amount\_msat* as the same
number ending in *msat*. If the invoice *status* is *paid*, there will be a number ending in *msat*. If the invoice was created with a bolt11 string,
there will be a *bolt11* field.
If the invoice *status* is *paid*, there will be a
*pay\_index* field and an *msatoshi\_received* field (which may be slightly *pay\_index* field and an *msatoshi\_received* field (which may be slightly
greater than *msatoshi* as some overpaying is permitted to allow clients to greater than *msatoshi* as some overpaying is permitted to allow clients to
obscure payment paths); there will also be an *amount\_received\_msat* field obscure payment paths); there will also be an *amount\_received\_msat* field

Loading…
Cancel
Save