mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 14:24:09 +01:00
d7cc1e4a17
Added descriptions for rpc command parameters This also performs the following fixes: 1. delforward parameters are compulsory (required). 2. disableinvoicerequest request added `added` field. 3. invoice request order fixed (label then description, not vice-versa!). 4. listpeers log levels are a proper enum 5. description parameter documented for sendonion requests. 6. deprecatred amount_msat removed from sendpay request. 7. sendpay request partid type fixed to u64 (was u16!) 8. sendpay request localinvreqid type tightened to hash (was hex) 9. sendpay request payment_metadata and description fields documented. 10. sendpsbt request reserve type fixed to u32 (was boolean) 11. utxopsbt request satoshi type fixed to msat_or_all (was msat) 12. withdraw request parameter satoshi is compulsory (required) 13. fundchannel_start request amount is sat, not msat_or_all. 14. openchannel_init request amount is sat, not msat 15. openchannel_init close_to is a string, not hex. 16: invoice labels can be strings OR numbers. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
28 lines
1 KiB
JSON
28 lines
1 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"required": [
|
|
"in_channel",
|
|
"in_htlc_id",
|
|
"status"
|
|
],
|
|
"properties": {
|
|
"in_channel": {
|
|
"type": "short_channel_id",
|
|
"description": "only the matching forwards on the given inbound channel are deleted.\tNote: for **listforwards** entries without an *in_htlc_id* entry (no longer created in v22.11, but can exist from older versions), a value of 18446744073709551615 can be used, but then it will delete *all* entries without *in_htlc_id* for this *in_channel* and *status*"
|
|
},
|
|
"in_htlc_id": {
|
|
"type": "u64",
|
|
"description": "the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "the status of the forward to delete. You cannot delete forwards which have status *offered* (i.e. are currently active)",
|
|
"enum": [
|
|
"settled",
|
|
"local_failed",
|
|
"failed"
|
|
]
|
|
}
|
|
}
|
|
}
|