docs: Adding readonly category for all get & list commands except l…

…istdatastore
ElementsProject · Jul 23, 2024 · ef0ca16 · ef0ca16
1 parent 88024fa
commit ef0ca16
Show file tree

Hide file tree

Showing 21 changed files with 120 additions and 0 deletions.
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
@@ -11407,6 +11407,9 @@
       "description": [
         "The **getinfo** gives a summary of the current running node."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {}
@@ -11838,6 +11841,9 @@
       "description": [
         "The **getlog** the RPC command to show logs, with optional log *level*."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -12098,6 +12104,9 @@
         "",
         "There are two considerations for how good a route is: how low the fees are, and how long your payment will get stuck in a delayed output if a node goes down during the process. ."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [
           "id",
@@ -13369,6 +13378,9 @@
         "",
         "Only one of *short_channel_id*, *source* or *destination* can be supplied. If nothing is supplied, data on all lightning channels known to this node, are returned. These can be local channels or public channels broadcast on the gossip network."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -13613,6 +13625,9 @@
       "description": [
         "The **listclosedchannels** RPC command returns data on channels which are otherwise forgotten (more than 100 blocks after they're completely resolved onchain)."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -13898,6 +13913,9 @@
       "description": [
         "The **listconfigs** RPC command to list all configuration options, or with *config* only one."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -16948,6 +16966,9 @@
       "description": [
         "The **listforwards** RPC command displays all htlcs that have been attempted to be forwarded by the Core Lightning node."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -17396,6 +17417,9 @@
       "description": [
         "The **listfunds** RPC command displays all funds available, either in unspent outputs (UTXOs) in the internal wallet or funds locked in currently open channels."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -17774,6 +17798,9 @@
       "description": [
         "The **listhtlcs** RPC command gets all HTLCs (which, generally, we remember for as long as a channel is open, even if they've completed long ago)."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -18036,6 +18063,9 @@
       "description": [
         "The **listinvoicerequests** RPC command gets the status of a specific `invoice_request`, if it exists, or the status of all `invoice_requests` if given no argument."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -18157,6 +18187,9 @@
         "",
         "Only one of the query parameters can be used from *label*, *invstring*, *payment_hash*, or *offer_id*."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -18483,6 +18516,9 @@
       "description": [
         "The **listnodes** command returns nodes the node has learned about via gossip messages, or a single one if the node *id* was specified."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -18818,6 +18854,9 @@
       "description": [
         "The **listoffers** RPC command list all offers, or with `offer_id`, only the offer with that offer_id (if it exists)."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -18963,6 +19002,9 @@
       "description": [
         "The **listpay** RPC command gets the status of all *pay* commands, or a single one if either *bolt11* or *payment_hash* was specified."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -19236,6 +19278,9 @@
         "",
         "If no *id* is supplied, then channel data on all lightning nodes that are connected, or not connected but have open channels with this node, are returned."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -20848,6 +20893,9 @@
         "",
         "The channel will remain open for a set blocktime, after which if the connection has not been re-established, the channel will close and the node will no longer appear in the command output."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -21206,6 +21254,9 @@
         "",
         "Note that there may be more than one concurrent *sendpay* command per *pay*, so this command should be used with caution."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -21608,6 +21659,9 @@
         "",
         "If *table* is given, only that table is in the resulting list, otherwise all tables are listed."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {
@@ -21884,6 +21938,9 @@
       "description": [
         "The **listtransactions** command returns transactions tracked in the wallet. This includes deposits, withdrawals and transactions related to channels. A transaction may have multiple types, e.g., a transaction may both be a close and a deposit if it closes the channel and returns funds to the wallet."
       ],
+      "categories": [
+        "readonly"
+      ],
       "request": {
         "required": [],
         "properties": {}

diff --git a/doc/rpc-schema-draft.json b/doc/rpc-schema-draft.json
@@ -366,6 +366,12 @@
                 "type": "string"
             }
         },
+        "categories": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
         "request": {
             "$ref": "#/definitions/schemaRequest"
         },

diff --git a/doc/schemas/lightning-getinfo.json b/doc/schemas/lightning-getinfo.json
@@ -7,6 +7,9 @@
   "description": [
     "The **getinfo** gives a summary of the current running node."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {}

diff --git a/doc/schemas/lightning-getlog.json b/doc/schemas/lightning-getlog.json
@@ -7,6 +7,9 @@
   "description": [
     "The **getlog** the RPC command to show logs, with optional log *level*."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-getroute.json b/doc/schemas/lightning-getroute.json
@@ -9,6 +9,9 @@
     "",
     "There are two considerations for how good a route is: how low the fees are, and how long your payment will get stuck in a delayed output if a node goes down during the process. ."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [
       "id",

diff --git a/doc/schemas/lightning-listchannels.json b/doc/schemas/lightning-listchannels.json
@@ -9,6 +9,9 @@
     "",
     "Only one of *short_channel_id*, *source* or *destination* can be supplied. If nothing is supplied, data on all lightning channels known to this node, are returned. These can be local channels or public channels broadcast on the gossip network."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listclosedchannels.json b/doc/schemas/lightning-listclosedchannels.json
@@ -8,6 +8,9 @@
   "description": [
     "The **listclosedchannels** RPC command returns data on channels which are otherwise forgotten (more than 100 blocks after they're completely resolved onchain)."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listconfigs.json b/doc/schemas/lightning-listconfigs.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listconfigs** RPC command to list all configuration options, or with *config* only one."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listforwards.json b/doc/schemas/lightning-listforwards.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listforwards** RPC command displays all htlcs that have been attempted to be forwarded by the Core Lightning node."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listfunds.json b/doc/schemas/lightning-listfunds.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listfunds** RPC command displays all funds available, either in unspent outputs (UTXOs) in the internal wallet or funds locked in currently open channels."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listhtlcs.json b/doc/schemas/lightning-listhtlcs.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listhtlcs** RPC command gets all HTLCs (which, generally, we remember for as long as a channel is open, even if they've completed long ago)."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listinvoicerequests.json b/doc/schemas/lightning-listinvoicerequests.json
@@ -8,6 +8,9 @@
   "description": [
     "The **listinvoicerequests** RPC command gets the status of a specific `invoice_request`, if it exists, or the status of all `invoice_requests` if given no argument."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listinvoices.json b/doc/schemas/lightning-listinvoices.json
@@ -9,6 +9,9 @@
     "",
     "Only one of the query parameters can be used from *label*, *invstring*, *payment_hash*, or *offer_id*."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listnodes.json b/doc/schemas/lightning-listnodes.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listnodes** command returns nodes the node has learned about via gossip messages, or a single one if the node *id* was specified."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listoffers.json b/doc/schemas/lightning-listoffers.json
@@ -8,6 +8,9 @@
   "description": [
     "The **listoffers** RPC command list all offers, or with `offer_id`, only the offer with that offer_id (if it exists)."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listpays.json b/doc/schemas/lightning-listpays.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listpay** RPC command gets the status of all *pay* commands, or a single one if either *bolt11* or *payment_hash* was specified."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listpeerchannels.json b/doc/schemas/lightning-listpeerchannels.json
@@ -10,6 +10,9 @@
     "",
     "If no *id* is supplied, then channel data on all lightning nodes that are connected, or not connected but have open channels with this node, are returned."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listpeers.json b/doc/schemas/lightning-listpeers.json
@@ -15,6 +15,9 @@
     "",
     "The channel will remain open for a set blocktime, after which if the connection has not been re-established, the channel will close and the node will no longer appear in the command output."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listsendpays.json b/doc/schemas/lightning-listsendpays.json
@@ -9,6 +9,9 @@
     "",
     "Note that there may be more than one concurrent *sendpay* command per *pay*, so this command should be used with caution."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listsqlschemas.json b/doc/schemas/lightning-listsqlschemas.json
@@ -10,6 +10,9 @@
     "",
     "If *table* is given, only that table is in the resulting list, otherwise all tables are listed."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {

diff --git a/doc/schemas/lightning-listtransactions.json b/doc/schemas/lightning-listtransactions.json
@@ -7,6 +7,9 @@
   "description": [
     "The **listtransactions** command returns transactions tracked in the wallet. This includes deposits, withdrawals and transactions related to channels. A transaction may have multiple types, e.g., a transaction may both be a close and a deposit if it closes the channel and returns funds to the wallet."
   ],
+  "categories": [
+    "readonly"
+  ],
   "request": {
     "required": [],
     "properties": {}