doc: fix listsendpays man page.

We actually had a partid allowed (in the oneOf clauses), but didn''t document it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
m-schmoock · Jan 30, 2023 · 83c690f · 83c690f
1 parent d6f46e2
commit 83c690f
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 1 deletion.
diff --git a/.msggen.json b/.msggen.json
@@ -819,6 +819,7 @@
             "ListSendPays.payments[].groupid": 2,
             "ListSendPays.payments[].id": 1,
             "ListSendPays.payments[].label": 9,
+            "ListSendPays.payments[].partid": 15,
             "ListSendPays.payments[].payment_hash": 3,
             "ListSendPays.payments[].payment_preimage": 12,
             "ListSendPays.payments[].status": 4

diff --git a/cln-grpc/proto/node.proto b/cln-grpc/proto/node.proto
diff --git a/cln-grpc/src/convert.rs b/cln-grpc/src/convert.rs
diff --git a/cln-rpc/src/model.rs b/cln-rpc/src/model.rs
diff --git a/contrib/pyln-testing/pyln/testing/grpc2py.py b/contrib/pyln-testing/pyln/testing/grpc2py.py
@@ -465,6 +465,7 @@ def listsendpays_payments2py(m):
     return remove_default({
         "id": m.id,  # PrimitiveField in generate_composite
         "groupid": m.groupid,  # PrimitiveField in generate_composite
+        "partid": m.partid,  # PrimitiveField in generate_composite
         "payment_hash": hexlify(m.payment_hash),  # PrimitiveField in generate_composite
         "status": str(m.status),  # EnumField in generate_composite
         "amount_msat": amount2msat(m.amount_msat),  # PrimitiveField in generate_composite

diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md
@@ -31,6 +31,7 @@ On success, an object containing **payments** is returned.  It is an array of ob
 - **status** (string): status of the payment (one of "pending", "failed", "complete")
 - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated
 - **amount\_sent\_msat** (msat): The amount sent
+- **partid** (u64, optional): Part number (for multiple parts to a single payment)
 - **amount\_msat** (msat, optional): The amount delivered to destination (if known)
 - **destination** (pubkey, optional): the final destination of the payment if known
 - **label** (string, optional): the label, if given to sendpay
@@ -64,4 +65,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:c7a067147e3275afa7f0cad68a6e1d9c0a10fad038a7b95b9c173edf523aee23)
+[comment]: # ( SHA256STAMP:a6dcb3708d706650f74fcdd4d05614a813ac5a69c13c4c579d45c01b106545e2)
diff --git a/doc/schemas/listsendpays.schema.json b/doc/schemas/listsendpays.schema.json
@@ -28,6 +28,10 @@
             "type": "u64",
             "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
           },
+          "partid": {
+            "type": "u64",
+            "description": "Part number (for multiple parts to a single payment)"
+          },
           "payment_hash": {
             "type": "hash",
             "description": "the hash of the *payment_preimage* which will prove payment",