core-lightning/doc/schemas/lightning-deprecations.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

55 lines
1.5 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"added": "v24.02",
"rpc": "deprecations",
"title": "Command to enable/disable deprecated APIs",
"description": [
"The **deprecations** RPC command is used to override global config option `allow-deprecated-apis` for further RPC commands on this same connection. This can be useful for developer testing to ensure you don't accidentally rely on deprecated features."
],
"request": {
"required": [
"enable"
],
"properties": {
"enable": {
"type": "boolean",
"description": [
"Flag to enable or disable deprecated APIs. Setting it to `false` will neither accept deprecated parameters or commands, nor output deprecated fields."
]
}
}
},
"response": {
"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."
],
"see_also": [
"lightningd-config(5)",
"lightning-notifications(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:deprecations#1",
"method": "deprecations",
"params": {
"enable": false
}
},
"response": {}
}
]
}