core-lightning/doc/schemas/lightning-askrene-listreservations.json
Rusty Russell d50838b60f askrene: implement listreservations
And actually write tests!

Suggested-by: Lagrang3 <lagrang3@protonmail.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-10-04 11:27:53 +09:30

72 lines
1.9 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "askrene-listreservations",
"title": "Command to display information about reservations (EXPERIMENTAL)",
"description": [
"WARNING: experimental, so API may change.",
"",
"The **askrene-reservations** RPC command reports outstanding reservations made with `askrene-reserve`, mainly for debugging."
],
"request": {
"required": [],
"properties": {}
},
"response": {
"required": [
"reservations"
],
"properties": {
"layers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"short_channel_id_dir",
"amount_msat",
"age_in_seconds",
"command_id"
],
"properties": {
"short_channel_id_dir": {
"type": "short_channel_id_dir",
"description": [
"The channel and direction that is reserved."
]
},
"amount_msat": {
"type": "msat",
"description": [
"The amount reserved."
]
},
"age_in_seconds": {
"type": "u64",
"description": [
"The age of this reservation."
]
},
"command_id": {
"type": "string",
"description": [
"The JSON id of the command used to make the reservation."
]
}
}
}
}
}
},
"see_also": [
"lightning-askrene-reserve(7)",
"lightning-askrene-unreserve(7)"
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}