core-lightning/doc/schemas/autoclean-status.schema.json
Rusty Russell 612f3de0d4 doc: manpages and schemas for autoclean-status.
And remove deprecated autocleaninvoice docs.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: Plugins: `autoclean-status` command to see what autoclean is doing.
Changelog-Deprecated: JSON-RPC: `autocleaninvoice` (use option `autoclean-expiredinvoices-age`)
2022-09-22 15:19:46 +02:00

347 lines
8.8 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"autoclean"
],
"properties": {
"autoclean": {
"type": "object",
"additionalProperties": false,
"properties": {
"succeededforwards": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for successful listforwards"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to delete successful listforwards"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
},
"failedforwards": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for failed listforwards"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to delete failed listforwards"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
},
"succeededpays": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for successful listpays/listsendpays"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to delete successful listpays/listsendpays"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
},
"failedpays": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for failed listpays/listsendpays"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to delete failed listpays/listsendpays"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
},
"paidinvoices": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for paid listinvoices"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to paid listinvoices"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
},
"expiredinvoices": {
"type": "object",
"additionalProperties": true,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "whether autocleaning is enabled for expired (unpaid) listinvoices"
},
"cleaned": {
"type": "u64",
"description": "total number of deletions done (ever)"
}
},
"if": {
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"enabled",
"age",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {},
"age": {
"type": "u64",
"description": "age (in seconds) to expired listinvoices"
}
}
},
"else": {
"additionalProperties": false,
"required": [
"enabled",
"cleaned"
],
"properties": {
"enabled": {},
"cleaned": {}
}
}
}
}
}
}
}