core-lightning/doc/schemas/lightning-askrene-age.json
Rusty Russell b327bd30c3 doc: fix all JSON schemas to enforce no additional properties.
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>
2024-10-30 15:39:12 +10:30

64 lines
1.6 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "askrene-age",
"title": "Command for expiring information in a layer (EXPERIMENTAL)",
"description": [
"WARNING: experimental, so API may change.",
"",
"The **askrene-age** RPC command tells askrene that information added to a layer by *askrene-inform-channel* beyond a certain age is less useful. It currently completely forgets constraints older than *cutoff*."
],
"request": {
"required": [
"layer",
"cutoff"
],
"additionalProperties": false,
"properties": {
"layer": {
"type": "string",
"description": [
"The name of the layer to apply this change to."
]
},
"cutoff": {
"type": "u64",
"description": [
"The UNIX timestamp: constraints older than this will be forgotten."
]
}
}
},
"response": {
"required": [
"layer",
"num_removed"
],
"additionalProperties": false,
"properties": {
"layer": {
"type": "string",
"description": [
"The *layer* parameter provided."
]
},
"num_removed": {
"type": "u64",
"description": [
"The number of constraints removed from *layer*"
]
}
}
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-listlayers(7)"
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}