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 <[email protected]>
ElementsProject · Oct 30, 2024 · b327bd3 · b327bd3
1 parent 7b2c791
commit b327bd3
Show file tree

Hide file tree

Showing 139 changed files with 730 additions and 298 deletions.
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
diff --git a/doc/rpc-schema-draft.json b/doc/rpc-schema-draft.json
@@ -261,6 +261,9 @@
             "type": "object",
             "additionalProperties": false,
             "properties": {
+                "additionalProperties": {
+                    "type": "boolean"
+                },
                 "required": {
                     "type": "array",
                     "items": {
@@ -290,6 +293,9 @@
             "type": "object",
             "additionalProperties": false,
             "properties": {
+                "additionalProperties": {
+                    "type": "boolean"
+                },
                 "required": {
                     "type": "array",
                     "items": {

diff --git a/doc/schemas/lightning-addgossip.json b/doc/schemas/lightning-addgossip.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "addgossip",
   "title": "Command for injecting a gossip message (low-level)",
   "description": [
@@ -15,6 +14,7 @@
     "required": [
       "message"
     ],
+    "additionalProperties": false,
     "properties": {
       "message": {
         "type": "hex",
@@ -25,6 +25,7 @@
     }
   },
   "response": {
+    "additionalProperties": false,
     "properties": {}
   },
   "author": [

diff --git a/doc/schemas/lightning-addpsbtoutput.json b/doc/schemas/lightning-addpsbtoutput.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "added": "v23.11",
   "rpc": "addpsbtoutput",
   "title": "Command to populate PSBT outputs from the wallet",
@@ -14,6 +13,7 @@
     "required": [
       "satoshi"
     ],
+    "additionalProperties": false,
     "properties": {
       "satoshi": {
         "type": "sat",
@@ -47,6 +47,7 @@
       "estimated_added_weight",
       "outnum"
     ],
+    "additionalProperties": false,
     "properties": {
       "psbt": {
         "type": "string",

diff --git a/doc/schemas/lightning-askrene-age.json b/doc/schemas/lightning-askrene-age.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-age",
   "title": "Command for expiring information in a layer (EXPERIMENTAL)",
   "description": [
@@ -14,6 +13,7 @@
       "layer",
       "cutoff"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -34,6 +34,7 @@
       "layer",
       "num_removed"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",

diff --git a/doc/schemas/lightning-askrene-create-channel.json b/doc/schemas/lightning-askrene-create-channel.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-create-channel",
   "title": "Command to add a channel to layer (EXPERIMENTAL)",
   "description": [
@@ -17,6 +16,7 @@
       "short_channel_id",
       "capacity_msat"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -53,6 +53,7 @@
   },
   "response": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "see_also": [

diff --git a/doc/schemas/lightning-askrene-create-layer.json b/doc/schemas/lightning-askrene-create-layer.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-create-layer",
   "title": "Command to create a new layer (EXPERIMENTAL)",
   "description": [
@@ -13,6 +12,7 @@
     "required": [
       "layer"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -26,6 +26,7 @@
     "required": [
       "layers"
     ],
+    "additionalProperties": false,
     "properties": {
       "layers": {
         "type": "array",
@@ -74,6 +75,7 @@
                   "short_channel_id",
                   "capacity_msat"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "source": {
                     "type": "pubkey",
@@ -109,6 +111,7 @@
                 "required": [
                   "short_channel_id_dir"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "htlc_minimum_msat": {
                     "type": "msat",
@@ -151,6 +154,7 @@
                   "short_channel_id",
                   "direction"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "short_channel_id": {
                     "type": "short_channel_id",

diff --git a/doc/schemas/lightning-askrene-disable-node.json b/doc/schemas/lightning-askrene-disable-node.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-disable-node",
   "title": "Command to disable all channels to/from a node in a layer (EXPERIMENTAL)",
   "description": [
@@ -14,6 +13,7 @@
       "layer",
       "node"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -31,6 +31,7 @@
   },
   "response": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "see_also": [

diff --git a/doc/schemas/lightning-askrene-inform-channel.json b/doc/schemas/lightning-askrene-inform-channel.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-inform-channel",
   "title": "Command to add channel capacity restrictions to layer (EXPERIMENTAL)",
   "description": [
@@ -16,6 +15,7 @@
       "amount_msat",
       "inform"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -52,6 +52,7 @@
     "required": [
       "constraints"
     ],
+    "additionalProperties": false,
     "properties": {
       "constraints": {
         "type": "array",
@@ -62,6 +63,7 @@
             "short_channel_id_dir",
             "timestamp"
           ],
+          "additionalProperties": false,
           "properties": {
             "short_channel_id_dir": {
               "type": "short_channel_id_dir",

diff --git a/doc/schemas/lightning-askrene-listlayers.json b/doc/schemas/lightning-askrene-listlayers.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-listlayers",
   "title": "Command to display information about layers (EXPERIMENTAL)",
   "description": [
@@ -11,6 +10,7 @@
   ],
   "request": {
     "required": [],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -24,6 +24,7 @@
     "required": [
       "layers"
     ],
+    "additionalProperties": false,
     "properties": {
       "layers": {
         "type": "array",
@@ -72,6 +73,7 @@
                   "short_channel_id",
                   "capacity_msat"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "source": {
                     "type": "pubkey",
@@ -107,6 +109,7 @@
                 "required": [
                   "short_channel_id_dir"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "short_channel_id_dir": {
                     "type": "short_channel_id_dir",
@@ -160,6 +163,7 @@
                 "required": [
                   "short_channel_id_dir"
                 ],
+                "additionalProperties": false,
                 "properties": {
                   "short_channel_id_dir": {
                     "type": "short_channel_id_dir",

diff --git a/doc/schemas/lightning-askrene-listreservations.json b/doc/schemas/lightning-askrene-listreservations.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-listreservations",
   "title": "Command to display information about reservations (EXPERIMENTAL)",
   "description": [
@@ -11,24 +10,26 @@
   ],
   "request": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "response": {
     "required": [
       "reservations"
     ],
+    "additionalProperties": false,
     "properties": {
       "reservations": {
         "type": "array",
         "items": {
           "type": "object",
-          "additionalProperties": false,
           "required": [
             "short_channel_id_dir",
             "amount_msat",
             "age_in_seconds",
             "command_id"
           ],
+          "additionalProperties": false,
           "properties": {
             "short_channel_id_dir": {
               "type": "short_channel_id_dir",

diff --git a/doc/schemas/lightning-askrene-remove-layer.json b/doc/schemas/lightning-askrene-remove-layer.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-remove-layer",
   "title": "Command to destroy a layer (EXPERIMENTAL)",
   "description": [
@@ -13,6 +12,7 @@
     "required": [
       "layer"
     ],
+    "additionalProperties": false,
     "properties": {
       "layer": {
         "type": "string",
@@ -24,6 +24,7 @@
   },
   "response": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "see_also": [

diff --git a/doc/schemas/lightning-askrene-reserve.json b/doc/schemas/lightning-askrene-reserve.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-reserve",
   "title": "Command for informing askrene that you are trying a path (EXPERIMENTAL)",
   "description": [
@@ -15,12 +14,13 @@
     "required": [
       "path"
     ],
+    "additionalProperties": false,
     "properties": {
       "path": {
         "type": "array",
         "items": {
           "type": "object",
-          "additionalProperties": true,
+          "additionalProperties": false,
           "required": [
             "short_channel_id_dir",
             "amount_msat"
@@ -45,6 +45,7 @@
   },
   "response": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "see_also": [

diff --git a/doc/schemas/lightning-askrene-unreserve.json b/doc/schemas/lightning-askrene-unreserve.json
@@ -1,7 +1,6 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "askrene-unreserve",
   "title": "Command for informing askrene that you are no longer trying a path (EXPERIMENTAL)",
   "description": [
@@ -15,12 +14,13 @@
     "required": [
       "path"
     ],
+    "additionalProperties": false,
     "properties": {
       "path": {
         "type": "array",
         "items": {
           "type": "object",
-          "additionalProperties": true,
+          "additionalProperties": false,
           "required": [
             "short_channel_id_dir",
             "amount_msat"
@@ -45,6 +45,7 @@
   },
   "response": {
     "required": [],
+    "additionalProperties": false,
     "properties": {}
   },
   "see_also": [