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>
50 lines
1.4 KiB
JSON
50 lines
1.4 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [],
|
|
"properties": {
|
|
"label": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
}
|
|
],
|
|
"description": "a label used a the creation of the invoice to get a specific invoice"
|
|
},
|
|
"invstring": {
|
|
"type": "string",
|
|
"description": "the string value to query a specific invoice"
|
|
},
|
|
"payment_hash": {
|
|
"type": "hex",
|
|
"description": "a payment_hash of the invoice to get the details of a specific invoice"
|
|
},
|
|
"offer_id": {
|
|
"type": "string",
|
|
"description": "a local `offer_id` the invoice was issued for a specific invoice details"
|
|
},
|
|
"index": {
|
|
"type": "string",
|
|
"added": "v23.08",
|
|
"enum": [
|
|
"created",
|
|
"updated"
|
|
],
|
|
"description": "if neither *in_channel* nor *out_channel* is specified, it controls ordering. Defaults to `created`"
|
|
},
|
|
"start": {
|
|
"type": "u64",
|
|
"added": "v23.08",
|
|
"description": "if `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)"
|
|
},
|
|
"limit": {
|
|
"type": "u32",
|
|
"added": "v23.08",
|
|
"description": "if `index` is specified, `limit` can be used to specify the maximum number of entries to return"
|
|
}
|
|
}
|
|
}
|