core-lightning/doc/schemas/commando.request.json
Rusty Russell 3f0c5b985b commando: add filtering support.
1. When we receive a commando command from a remote using the `filter`
   field, use it.
2. Add a `filter` parameter to `commando` to send it: this is usually
   more efficient than using filtering locally.

Of course, older remote nodes will ignore the filter, but that's
harmless.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: Plugins: `commando` now supports `filter` as a parameter (for send and receive).
2023-01-11 11:13:27 +10:30

41 lines
869 B
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"peer_id",
"method"
],
"properties": {
"peer_id": {
"type": "pubkey",
"description": "peer to command"
},
"method": {
"type": "string",
"description": "method to invoke on peer"
},
"params": {
"oneOf": [
{
"type": "array",
"description": "array of positional parameters"
},
{
"type": "object",
"description": "parameters for method"
}
]
},
"rune": {
"type": "string",
"description": "rune to authorize the command"
},
"filter": {
"type": "object",
"additionalProperties": true,
"description": "filter to peer to apply to any successful result"
}
}
}