rpc: Removing category and verbose from json_command struct

Author: ShahanaFarooqui

cli/lightning-cli.c

@@ -183,9 +183,7 @@ static void human_help(char *buffer, const jsmntok_t *result)
 	/* Contains all commands objects, which have the following structure :
 	 * {
 	 *     "command": "The command name and usage",
-	 *     "category": "The command category",
-	 *     "description": "The command's description",
-	 *     "verbose": "The command's detailed description"
+	 *     "description": "The command's description"
 	 * }
 	 */
 	const jsmntok_t * help_array = json_get_member(buffer, result, "help");

cln-grpc/proto/node.proto

@@ -12568,9 +12568,7 @@
               "additionalProperties": true,
               "required": [
                 "command",
-                "category",
-                "description",
-                "verbose"
+                "description"
               ],
               "properties": {
                 "command": {
@@ -12579,23 +12577,11 @@
                     "The command."
                   ]
                 },
-                "category": {
-                  "type": "string",
-                  "description": [
-                    "The category for this command (useful for grouping)."
-                  ]
-                },
                 "description": {
                   "type": "string",
                   "description": [
                     "A one-line description of the purpose of this command."
                   ]
-                },
-                "verbose": {
-                  "type": "string",
-                  "description": [
-                    "A full description of this command (including whether it's deprecated)."
-                  ]
                 }
               }
             }
@@ -12636,9 +12622,7 @@
             "help": [
               {
                 "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]",
-                "category": "plugin",
-                "description": "Send payment specified by {bolt11}",
-                "verbose": "Attempt to pay the {bolt11} invoice."
+                "description": "Send payment specified by {bolt11}"
               }
             ],
             "format-hint": "simple"
@@ -12656,9 +12640,7 @@
             "help": [
               {
                 "command": "dev subcommand=crash|rhash|slowcmd",
-                "category": "developer",
-                "description": "Developer command test multiplexer",
-                "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n"
+                "description": "Developer command test multiplexer"
               }
             ],
             "format-hint": "simple"

cln-grpc/src/convert.rs

@@ -2617,10 +2617,8 @@ def stop2py(m):
 
 def help_help2py(m):
     return remove_default({
-        "category": m.category,  # PrimitiveField in generate_composite
         "command": m.command,  # PrimitiveField in generate_composite
         "description": m.description,  # PrimitiveField in generate_composite
-        "verbose": m.verbose,  # PrimitiveField in generate_composite
     })
 
 

cln-rpc/src/model.rs

@@ -32,9 +32,7 @@
           "additionalProperties": true,
           "required": [
             "command",
-            "category",
-            "description",
-            "verbose"
+            "description"
           ],
           "properties": {
             "command": {
@@ -43,23 +41,11 @@
                 "The command."
               ]
             },
-            "category": {
-              "type": "string",
-              "description": [
-                "The category for this command (useful for grouping)."
-              ]
-            },
             "description": {
               "type": "string",
               "description": [
                 "A one-line description of the purpose of this command."
               ]
-            },
-            "verbose": {
-              "type": "string",
-              "description": [
-                "A full description of this command (including whether it's deprecated)."
-              ]
             }
           }
         }
@@ -100,9 +86,7 @@
         "help": [
           {
             "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]",
-            "category": "plugin",
-            "description": "Send payment specified by {bolt11}",
-            "verbose": "Attempt to pay the {bolt11} invoice."
+            "description": "Send payment specified by {bolt11}"
           }
         ],
         "format-hint": "simple"
@@ -120,9 +104,7 @@
         "help": [
           {
             "command": "dev subcommand=crash|rhash|slowcmd",
-            "category": "developer",
-            "description": "Developer command test multiplexer",
-            "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n"
+            "description": "Developer command test multiplexer"
           }
         ],
         "format-hint": "simple"

contrib/msggen/msggen/schema.json

@@ -755,7 +755,6 @@ static struct command_result *json_feerates(struct command *cmd,
 
 static const struct json_command feerates_command = {
 	"feerates",
-	"bitcoin",
 	json_feerates,
 	"Return feerate estimates, either satoshi-per-kw ({style} perkw) or satoshi-per-kb ({style} perkb)."
 };
@@ -782,7 +781,6 @@ static struct command_result *json_parse_feerate(struct command *cmd,
 
 static const struct json_command parse_feerate_command = {
 	"parsefeerate",
-	"bitcoin",
 	json_parse_feerate,
 	"Return current feerate in perkw + perkb for given feerate string."
 };

contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py

@@ -2198,7 +2198,6 @@ static struct command_result *json_splice_signed(struct command *cmd,
 
 static const struct json_command splice_init_command = {
 	"splice_init",
-	"channels",
 	json_splice_init,
 	"Init a channel splice to {channel_id} for {relative_amount} satoshis with {initialpsbt}. "
 	"Returns updated {psbt} with (partial) contributions from peer"
@@ -2207,7 +2206,6 @@ AUTODATA(json_command, &splice_init_command);
 
 static const struct json_command splice_update_command = {
 	"splice_update",
-	"channels",
 	json_splice_update,
 	"Update {channel_id} currently active negotiated splice with {psbt}. "
 	""
@@ -2220,7 +2218,6 @@ AUTODATA(json_command, &splice_update_command);
 
 static const struct json_command splice_signed_command = {
 	"splice_signed",
-	"channels",
 	json_splice_signed,
 	"Send our {signed_psbt}'s tx sigs for {channel_id}."
 };
@@ -2274,7 +2271,6 @@ static struct command_result *json_dev_feerate(struct command *cmd,
 
 static const struct json_command dev_feerate_command = {
 	"dev-feerate",
-	"developer",
 	json_dev_feerate,
 	"Set feerate for {id} to {feerate}",
 	.dev_only = true,
@@ -2331,7 +2327,6 @@ static struct command_result *json_dev_quiesce(struct command *cmd,
 
 static const struct json_command dev_quiesce_command = {
 	"dev-quiesce",
-	"developer",
 	json_dev_quiesce,
 	"Initiate quiscence protocol with peer",
 	.dev_only = true,