core-lightning/doc/schemas/lightning-delexpiredinvoice.json
ShahanaFarooqui 04884ca664 doc: Merge request and schema jsons in a single file
Merge information from `*.request.json` & `*.schema.json`. Also consolidate remaining details from `*.md` files and create a single file in schemas folder.
2024-03-19 14:58:59 +10:30

47 lines
1.1 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "delexpiredinvoice",
"title": "Command for removing expired invoices",
"description": [
"The **delexpiredinvoice** RPC command removes all invoices that have expired on or before the given *maxexpirytime*."
],
"request": {
"required": [],
"properties": {
"maxexpirytime": {
"type": "u64",
"description": [
"Invoice expiry time in seconds. If not specified then all expired invoices are deleted."
]
}
}
},
"response": {
"required": [],
"properties": {}
},
"example_json_request": [
{
"id": "example:delexpiredinvoice#1",
"method": "delexpiredinvoice",
"params": {
"maxexpirytime": null
}
}
],
"example_json_response": [
{}
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-delinvoice(7)",
"lightning-autoclean-status(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}