Update listsendpays documentation to explain when amount_msat is not present #8144
Conversation
…present Fixes ElementsProject#6909 Update the documentation of `listsendpays` to be more explicit about when the `amount_msat` field might not be present. * Update the description of the `amount_msat` field in `doc/schemas/lightning-listsendpays.json` to explain that it might not be present if the payment is still pending or if the amount delivered to the destination is not known. * Add a note in the `response` section to indicate that if the `amount_msat` field is not present, it means the payment is still pending or the amount delivered to the destination is not known. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ElementsProject/lightning/issues/6909?shareId=XXXX-XXXX-XXXX-XXXX).
Can u brief me about that "extra test" |
|
Sorry I made a typo, you need to update the md file too, there is an extra step that is running |
|
Can you specify which md file |
| @@ -144,7 +144,7 @@ | |||
| "amount_msat": { | |||
| "type": "msat", | |||
| "description": [ | |||
| "The amount delivered to destination (if known)." | |||
| "The amount delivered to destination (if known). This field might not be present if the payment is still pending or if the amount delivered to the destination is not known." | |||
There was a problem hiding this comment.
No, it means that the caller used "sendonion" so we don't know how much actually got delivered.
| @@ -326,7 +326,8 @@ | |||
| } | |||
| }, | |||
| "pre_return_value_notes": [ | |||
| "Note that the returned array is ordered by increasing *id*." | |||
| "Note that the returned array is ordered by increasing *id*.", | |||
| "If the `amount_msat` field is not present, it means the payment is still pending or the amount delivered to the destination is not known." | |||
There was a problem hiding this comment.
This one seems redundant?
|
Hi @shashankxrm, while working on @rustyrussell's requested changes, could you please:
|
Fixes #6909
Update the documentation of
listsendpaysto be more explicit about when theamount_msatfield might not be present.amount_msatfield indoc/schemas/lightning-listsendpays.jsonto explain that it might not be present if the payment is still pending or if the amount delivered to the destination is not known.responsesection to indicate that if theamount_msatfield is not present, it means the payment is still pending or the amount delivered to the destination is not known.For more details, open the Copilot Workspace session.