3e841b358e
Changelog-Fixed: Ensure documentation renders correctly when adding/updating new RPCs by detecting non-MDX-compatible pages.
109 lines
3.1 KiB
JSON
109 lines
3.1 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"added": "v22.11",
|
|
"rpc": "disableinvoicerequest",
|
|
"title": "Command for removing an invoice request",
|
|
"description": [
|
|
"The **disableinvoicerequest** RPC command disables an invoice_request, so that no further invoices will be accepted (and thus, no further payments made)..",
|
|
"",
|
|
"We currently don't support deletion of invoice_requests, so they are not forgotten entirely (there may be payments which refer to this invoice_request)."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"invreq_id"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"invreq_id": {
|
|
"type": "string",
|
|
"description": [
|
|
"A specific invoice can be disabled by providing the `invreq_id`, which is presented by lightning-invoicerequest(7)."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"invreq_id",
|
|
"single_use",
|
|
"active",
|
|
"bolt12",
|
|
"used"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"invreq_id": {
|
|
"type": "hash",
|
|
"description": [
|
|
"The SHA256 hash of all invoice_request fields less than 160."
|
|
]
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"enum": [
|
|
false
|
|
],
|
|
"description": [
|
|
"Whether the invoice_request is currently active."
|
|
]
|
|
},
|
|
"single_use": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Whether the invoice_request will become inactive after we pay an invoice for it."
|
|
]
|
|
},
|
|
"bolt12": {
|
|
"type": "string",
|
|
"description": [
|
|
"The bolt12 string starting with lnr."
|
|
]
|
|
},
|
|
"used": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Whether the invoice_request has already been used."
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": [
|
|
"The label provided when creating the invoice_request."
|
|
]
|
|
}
|
|
},
|
|
"pre_return_value_notes": [
|
|
"Note: the returned object is the same format as **listinvoicerequests**."
|
|
]
|
|
},
|
|
"author": [
|
|
"Rusty Russell [rusty@rustcorp.com.au](mailto:rusty@rustcorp.com.au) is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-invoicerequest(7)",
|
|
"lightning-listinvoicerequests(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:disableinvoicerequest#1",
|
|
"method": "disableinvoicerequest",
|
|
"params": {
|
|
"invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202"
|
|
}
|
|
},
|
|
"response": {
|
|
"invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202",
|
|
"active": false,
|
|
"single_use": true,
|
|
"bolt12": "lno1qgsq000bolt240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000",
|
|
"used": false
|
|
}
|
|
}
|
|
]
|
|
}
|