davide/palladum-lightning
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

doc: improve documentation of listpays

Browse Source 
1. It's called listpays not listpay.
2. "index" does NOT have a default value (it must be specified if limit or start are used)
3. Note that limit and start have effects on accuracy, since we combine records.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2024-11-11 10:48:03 +10:30
committed by Vincenzo Palazzo
parent c4e67c0b96
commit fcdbbd8534
3 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cln-rpc/src/model.rs generated
View File

@@ -2615,7 +2615,7 @@ pub mod requests {
"listoffers"
}
}
/// ['If neither *in_channel* nor *out_channel* is specified, it controls ordering.']
/// ['If neither *in_channel* nor *out_channel* is specified, it controls ordering, by `created` or `updated`.']
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub enum ListpaysIndex {
#[serde(rename = "created")]

14
contrib/msggen/msggen/schema.json
View File

@@ -23584,7 +23584,7 @@
"rpc": "listpays",
"title": "Command for querying payment status",
"description": [
"The **listpay** RPC command gets the status of all *pay* commands, or a single one if either *bolt11* or *payment_hash* was specified."
"The **listpays** RPC command gets the status of all *pay* commands (by combining results from listsendpays which lists every payment part), or a single one if either *bolt11* or *payment_hash* was specified."
],
"categories": [
"readonly"
@@ -23624,22 +23624,24 @@
"updated"
],
"description": [
"If neither *in_channel* nor *out_channel* is specified, it controls ordering."
],
"default": "`created`"
"If neither *in_channel* nor *out_channel* is specified, it controls ordering, by `created` or `updated`."
]
},
"start": {
"type": "u64",
"added": "v24.11",
"description": [
"If `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)."
"If `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7).",
"NOTE: if this is used, `amount_sent_msat` and `number_of_parts` fields may be lower than expected, as not all payment parts will be considered"
]
},
"limit": {
"type": "u32",
"added": "v24.11",
"description": [
"If `index` is specified, `limit` can be used to specify the maximum number of entries to return."
"If `index` is specified, `limit` can be used to specify the maximum number of entries to return.",
"NOTE: if this is used, `amount_sent_msat` and `number_of_parts` fields may be lower than expected, as not all payment parts will be considered",
"NOTE: the actual number returned may be less than the limit, as individual payment parts are combined together"
]
}
}

14
doc/schemas/lightning-listpays.json
View File

@@ -4,7 +4,7 @@
"rpc": "listpays",
"title": "Command for querying payment status",
"description": [
"The **listpay** RPC command gets the status of all *pay* commands, or a single one if either *bolt11* or *payment_hash* was specified."
"The **listpays** RPC command gets the status of all *pay* commands (by combining results from listsendpays which lists every payment part), or a single one if either *bolt11* or *payment_hash* was specified."
],
"categories": [
"readonly"
@@ -44,22 +44,24 @@
"updated"
],
"description": [
"If neither *in_channel* nor *out_channel* is specified, it controls ordering."
],
"default": "`created`"
"If neither *in_channel* nor *out_channel* is specified, it controls ordering, by `created` or `updated`."
]
},
"start": {
"type": "u64",
"added": "v24.11",
"description": [
"If `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)."
"If `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7).",
"NOTE: if this is used, `amount_sent_msat` and `number_of_parts` fields may be lower than expected, as not all payment parts will be considered"
]
},
"limit": {
"type": "u32",
"added": "v24.11",
"description": [
"If `index` is specified, `limit` can be used to specify the maximum number of entries to return."
"If `index` is specified, `limit` can be used to specify the maximum number of entries to return.",
"NOTE: if this is used, `amount_sent_msat` and `number_of_parts` fields may be lower than expected, as not all payment parts will be considered",
"NOTE: the actual number returned may be less than the limit, as individual payment parts are combined together"
]
}
}