core-lightning/doc/schemas/delinvoice.request.json

36 lines
947 B
JSON
Raw Normal View History

2022-04-01 14:42:45 +10:30
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"label",
"status"
],
"properties": {
"label": {
"oneOf": [
{
"type": "string"
},
{
"type": "u64"
}
],
"description": "label of the invoice to be deleted"
2022-04-01 14:42:45 +10:30
},
"status": {
"type": "string",
"description": "label of the invoice to be deleted. The caller should be particularly aware of the error case caused by the *status* changing just before this command is invoked!",
2022-04-01 14:42:45 +10:30
"enum": [
"paid",
"expired",
"unpaid"
]
},
"desconly": {
"type": "boolean",
"description": "if set to True, the invoice is not deleted, but has its description removed (this can save space with very large descriptions, as would be used with lightning-invoice(7) *deschashonly*"
2022-04-01 14:42:45 +10:30
}
}
}