core-lightning/doc/schemas/listinvoicerequests.schema.json
Rusty Russell 5e394ef53f doc: add documentation for invoicerequest commands.
As reported on Discord, these are undocumented.  And thus, um, hard to find!

Reported-by: Aaron Barnard
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-03-09 06:56:06 -06:00

51 lines
1.4 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"invoicerequests"
],
"properties": {
"invoicerequests": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"required": [
"invreq_id",
"single_use",
"active",
"bolt12",
"used"
],
"properties": {
"invreq_id": {
"type": "hash",
"description": "the SHA256 hash of all invoice_request fields less than 160"
},
"active": {
"type": "boolean",
"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"
}
}
}
}
}
}