mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 09:54:16 +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>
575 lines
17 KiB
JSON
575 lines
17 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
|
"title": "Core lightning rpc or notification meta-schema",
|
|
"definitions": {
|
|
"nonNegativeInteger": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"nonNegativeIntegerDefault0": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/nonNegativeInteger"
|
|
},
|
|
{
|
|
"default": 0
|
|
}
|
|
]
|
|
},
|
|
"simpleTypes": {
|
|
"enum": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string",
|
|
"hex",
|
|
"hash",
|
|
"secret",
|
|
"u64",
|
|
"u32",
|
|
"u16",
|
|
"u8",
|
|
"pubkey",
|
|
"sat",
|
|
"sat_or_all",
|
|
"msat",
|
|
"msat_or_all",
|
|
"msat_or_any",
|
|
"currency",
|
|
"txid",
|
|
"signature",
|
|
"bip340sig",
|
|
"short_channel_id",
|
|
"short_channel_id_dir",
|
|
"outpoint",
|
|
"feerate",
|
|
"outputdesc"
|
|
]
|
|
},
|
|
"schemaArray": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"properties": {
|
|
"type": {
|
|
"$ref": "#/definitions/simpleTypes"
|
|
},
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemaIfThenElse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"properties": {
|
|
"patternProperties": {
|
|
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"$ref": "#/definitions/simpleTypes"
|
|
},
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemaItems": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"type": {
|
|
"$ref": "#/definitions/simpleTypes"
|
|
},
|
|
"additionalProperties": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"items": {
|
|
"$ref": "#/definitions/schemaItems"
|
|
},
|
|
"properties": {
|
|
"$ref": "#/definitions/schemaObject"
|
|
},
|
|
"enum": {
|
|
"type": "array",
|
|
"items": true,
|
|
"minItems": 1,
|
|
"uniqueItems": true
|
|
},
|
|
"if": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"then": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"else": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"allOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"anyOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"oneOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
}
|
|
}
|
|
},
|
|
"schemaObject": {
|
|
"type": "object",
|
|
"patternProperties": {
|
|
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"type": {
|
|
"$ref": "#/definitions/simpleTypes"
|
|
},
|
|
"additionalProperties": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"hidden": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"untyped": {
|
|
"type": "boolean"
|
|
},
|
|
"comment": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"properties": {
|
|
"$ref": "#/definitions/schemaObject"
|
|
},
|
|
"items": {
|
|
"$ref": "#/definitions/schemaItems"
|
|
},
|
|
"default": {
|
|
"type": [
|
|
"string",
|
|
"number",
|
|
"boolean",
|
|
"array",
|
|
"object",
|
|
"null"
|
|
]
|
|
},
|
|
"added": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"maximum": {
|
|
"type": "number"
|
|
},
|
|
"minimum": {
|
|
"type": "number"
|
|
},
|
|
"maxLength": {
|
|
"$ref": "#/definitions/nonNegativeInteger"
|
|
},
|
|
"minLength": {
|
|
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
},
|
|
"pattern": {
|
|
"type": "string",
|
|
"format": "regex"
|
|
},
|
|
"enum": {
|
|
"type": "array",
|
|
"items": true,
|
|
"minItems": 1,
|
|
"uniqueItems": true
|
|
},
|
|
"format": {
|
|
"type": "string"
|
|
},
|
|
"if": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"then": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"else": {
|
|
"$ref": "#/definitions/schemaIfThenElse"
|
|
},
|
|
"allOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"anyOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"oneOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemaRequest": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
},
|
|
"required": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"properties": {
|
|
"$ref": "#/definitions/schemaObject"
|
|
},
|
|
"oneOfMany": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"pairedWith": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"dependentUpon": {
|
|
"type": "object",
|
|
"patternProperties": {
|
|
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemaResponse": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
},
|
|
"required": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pre_return_value_notes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"post_return_value_notes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"properties": {
|
|
"$ref": "#/definitions/schemaObject"
|
|
},
|
|
"allOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"anyOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
},
|
|
"oneOf": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"$schema": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
},
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"object"
|
|
]
|
|
},
|
|
"added": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"warning": {
|
|
"type": "string"
|
|
},
|
|
"rpc": {
|
|
"type": "string"
|
|
},
|
|
"notification": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"categories": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"request": {
|
|
"$ref": "#/definitions/schemaRequest"
|
|
},
|
|
"reliability": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"usage": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"restriction_format": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"examples": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"description": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"method": {
|
|
"type": "string"
|
|
},
|
|
"params": {}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"method",
|
|
"params"
|
|
]
|
|
},
|
|
"response": {
|
|
"type": "object",
|
|
"properties": {
|
|
"patternProperties": {
|
|
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
|
|
"$ref": "#/definitions/schemaArray"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"request",
|
|
"response"
|
|
]
|
|
}
|
|
},
|
|
"notes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"notifications": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"sharing_runes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"riskfactor_effect_on_routing": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"recommended_riskfactor_values": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"optimality": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"randomization": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"response": {
|
|
"$ref": "#/definitions/schemaResponse"
|
|
},
|
|
"treatment_of_types": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"permitted_sqlite3_functions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"tables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"example_notifications": {
|
|
"type": "array",
|
|
"items": {
|
|
"method": {
|
|
"type": "string"
|
|
},
|
|
"params": {}
|
|
}
|
|
},
|
|
"trivia": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"errors": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"author": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"see_also": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"resources": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"required": [
|
|
"$schema",
|
|
"type",
|
|
"rpc",
|
|
"title",
|
|
"description",
|
|
"request",
|
|
"response"
|
|
]
|
|
},
|
|
{
|
|
"required": [
|
|
"$schema",
|
|
"type",
|
|
"notification",
|
|
"title",
|
|
"description",
|
|
"request",
|
|
"response"
|
|
]
|
|
}
|
|
]
|
|
} |