core-lightning/doc/schemas/lightning-staticbackup.json
ShahanaFarooqui 976c0c90bc docs: Changes examples format
- Changed ALL `doc/schemas/lightning-*.json` file's `json_example` to `examples`
- Change the heading from example to examples
- Bring shell command before the json command
- Move Example to the end of the page
- Remove horizontal line from Example
2024-06-22 17:02:33 +02:00

54 lines
1.3 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "staticbackup",
"title": "Command for deriving getting SCB of all the existing channels",
"description": [
"The **staticbackup** RPC command returns an object with SCB of all the channels in an array."
],
"request": {
"required": [],
"properties": {}
},
"response": {
"required": [
"scb"
],
"properties": {
"scb": {
"type": "array",
"items": {
"type": "hex",
"description": [
"SCB of a channel in TLV format."
]
}
}
}
},
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:staticbackup#1",
"method": "staticbackup",
"params": {}
},
"response": {
"scb": [
"0000000000000001c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc651022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f000001b2e3c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc6510000000000000000000186a000021000"
]
}
}
]
}