mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-29 10:04:41 +01:00
Code Issues Projects Releases Wiki Activity
cc40243399
core-lightning/doc/schemas/close.request.json

42 lines
794 B
JSON
Raw Normal View History

json-rpc: Add request stubs for a couple of calls These are required so we can generate the requests, not just the responses. We'll add more as we test compatibility with our generation code.
2022-01-14 14:03:19 +01:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
doc: set additionalProperties to false in all request schemas. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:12:45 +02:00
"additionalProperties": false,
json-rpc: Add request stubs for a couple of calls These are required so we can generate the requests, not just the responses. We'll add more as we test compatibility with our generation code.
2022-01-14 14:03:19 +01:00
"required": [
"id"
],
"properties": {
"id": {
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
"type": "string",
"description": "peer id, channel id or short_channel_id"
json-rpc: Add request stubs for a couple of calls These are required so we can generate the requests, not just the responses. We'll add more as we test compatibility with our generation code.
2022-01-14 14:03:19 +01:00
},
"unilateraltimeout": {
"type": "u32",
"description": ""
},
"destination": {
"type": "string",
"description": ""
},
"fee_negotiation_step": {
"type": "string",
"description": ""
},
"wrong_funding": {
"type": "txid",
"description": ""
},
"force_lease_closed": {
"type": "boolean",
"description": ""
},
"feerange": {
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
"type": "array",
"items": {
"type": "feerate"
json-rpc: Add request stubs for a couple of calls These are required so we can generate the requests, not just the responses. We'll add more as we test compatibility with our generation code.
2022-01-14 14:03:19 +01:00
},
"description": ""
}
}
}
Reference in New Issue Copy Permalink