mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 22:31:48 +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>
31 lines
807 B
JSON
31 lines
807 B
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"required": [
|
|
"payment_hash",
|
|
"status"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"payment_hash": {
|
|
"type": "hash",
|
|
"description": "the unique identifier of a payment"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "expected status of the payment. Only deletes if the payment status matches. Deleting a `pending` payment will return an error",
|
|
"enum": [
|
|
"complete",
|
|
"failed"
|
|
]
|
|
},
|
|
"partid": {
|
|
"type": "u64",
|
|
"description": "specific partid to delete (must be paired with *groupid*)"
|
|
},
|
|
"groupid": {
|
|
"type": "u64",
|
|
"description": "specific groupid to delete (must be paired with *partid*)"
|
|
}
|
|
}
|
|
}
|