mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-23 06:55:13 +01:00
b327bd30c3
Without this, we have hardly any enforcement. This is why the schema
mistake fixed in the previous patches weren't spotted immediately.
The hard work was done by:
```
$ for f in lightning-*.json; do grep -v '^ "additionalProperties": false,' $f | bagto $f; done
$ for f in lightning-*.json; do sed 's/"properties": {/"additionalProperties": false, "properties": {/' $f | bagto $f; done
$ make fmt-schemas
```
Then checking where 'additionalProperties: true' had been turned to
false (we deliberately use it in some places where there are if
statements in the schema, or occasionally where there can be arbitrary
fields).
[Including doc/rpc-schema-draft.json update by Shahana]
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
51 lines
1.4 KiB
JSON
51 lines
1.4 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"rpc": "batching",
|
|
"title": "Command to allow database batching.",
|
|
"description": [
|
|
"The **batching** RPC command allows (but does not guarantee!) database commitments to be deferred when multiple commands are issued on this RPC connection. This is only useful if many commands are being given at once, in which case it can offer a performance improvement (the cost being that if there is a crash, it's unclear how many of the commands will have been persisted)."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"enable"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"enable": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Whether to enable or disable transaction batching."
|
|
],
|
|
"default": "False"
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"additionalProperties": false,
|
|
"properties": {}
|
|
},
|
|
"errors": [
|
|
"On failure, one of the following error codes may be returned:",
|
|
"",
|
|
"- -32602: Error in given parameters."
|
|
],
|
|
"author": [
|
|
"Rusty Russell <<rusty@blockstream.com>> wrote the initial version of this man page."
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:batching#1",
|
|
"method": "batching",
|
|
"params": {
|
|
"enable": true
|
|
}
|
|
},
|
|
"response": {}
|
|
}
|
|
]
|
|
}
|