rpc: Removing description from json_command struct

Author: ShahanaFarooqui

cli/lightning-cli.c

@@ -179,11 +179,9 @@ static void human_help(char *buffer, const jsmntok_t *result)
 	unsigned int i;
 	/* `curr` is used as a temporary token */
 	const jsmntok_t *curr;
-	const char *prev_cat;
 	/* Contains all commands objects, which have the following structure :
 	 * {
-	 *     "command": "The command name and usage",
-	 *     "description": "The command's description"
+	 *     "command": "The command name and usage"
 	 * }
 	 */
 	const jsmntok_t * help_array = json_get_member(buffer, result, "help");
@@ -196,22 +194,11 @@ static void human_help(char *buffer, const jsmntok_t *result)
 
 	asort(help, tal_count(help), compare_help, buffer);
 
-	prev_cat = "";
 	for (i = 0; i < tal_count(help); i++) {
-		const jsmntok_t *category, *command, *desc;
-
-		category = json_get_member(buffer, help[i], "category");
-		if (category && !json_tok_streq(buffer, category, prev_cat)) {
-			prev_cat = json_strdup(help, buffer, category);
-			printf("=== %s ===\n\n", prev_cat);
-		}
-
+		const jsmntok_t *command;
 		command = json_get_member(buffer, help[i], "command");
-		desc = json_get_member(buffer, help[i], "description");
-		printf("%.*s\n",
+		printf("%.*s\n\n",
 		       command->end - command->start, buffer + command->start);
-		printf("    %.*s\n\n",
-		       desc->end - desc->start, buffer + desc->start);
 	}
 	tal_free(help);
 

cln-grpc/proto/node.proto

@@ -12567,21 +12567,14 @@
               "type": "object",
               "additionalProperties": true,
               "required": [
-                "command",
-                "description"
+                "command"
               ],
               "properties": {
                 "command": {
                   "type": "string",
                   "description": [
                     "The command."
                   ]
-                },
-                "description": {
-                  "type": "string",
-                  "description": [
-                    "A one-line description of the purpose of this command."
-                  ]
                 }
               }
             }
@@ -12621,8 +12614,7 @@
           "response": {
             "help": [
               {
-                "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]",
-                "description": "Send payment specified by {bolt11}"
+                "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]"
               }
             ],
             "format-hint": "simple"
@@ -12639,8 +12631,7 @@
           "response": {
             "help": [
               {
-                "command": "dev subcommand=crash|rhash|slowcmd",
-                "description": "Developer command test multiplexer"
+                "command": "dev subcommand=crash|rhash|slowcmd"
               }
             ],
             "format-hint": "simple"

cln-grpc/src/convert.rs

@@ -2618,7 +2618,6 @@ def stop2py(m):
 def help_help2py(m):
     return remove_default({
         "command": m.command,  # PrimitiveField in generate_composite
-        "description": m.description,  # PrimitiveField in generate_composite
     })
 
 

cln-rpc/src/model.rs

@@ -31,21 +31,14 @@
           "type": "object",
           "additionalProperties": true,
           "required": [
-            "command",
-            "description"
+            "command"
           ],
           "properties": {
             "command": {
               "type": "string",
               "description": [
                 "The command."
               ]
-            },
-            "description": {
-              "type": "string",
-              "description": [
-                "A one-line description of the purpose of this command."
-              ]
             }
           }
         }
@@ -85,8 +78,7 @@
       "response": {
         "help": [
           {
-            "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]",
-            "description": "Send payment specified by {bolt11}"
+            "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]"
           }
         ],
         "format-hint": "simple"
@@ -103,8 +95,7 @@
       "response": {
         "help": [
           {
-            "command": "dev subcommand=crash|rhash|slowcmd",
-            "description": "Developer command test multiplexer"
+            "command": "dev subcommand=crash|rhash|slowcmd"
           }
         ],
         "format-hint": "simple"

contrib/msggen/msggen/schema.json

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

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

@@ -2199,27 +2199,18 @@ static struct command_result *json_splice_signed(struct command *cmd,
 static const struct json_command splice_init_command = {
 	"splice_init",
 	json_splice_init,
-	"Init a channel splice to {channel_id} for {relative_amount} satoshis with {initialpsbt}. "
-	"Returns updated {psbt} with (partial) contributions from peer"
 };
 AUTODATA(json_command, &splice_init_command);
 
 static const struct json_command splice_update_command = {
 	"splice_update",
 	json_splice_update,
-	"Update {channel_id} currently active negotiated splice with {psbt}. "
-	""
-	"Returns updated {psbt} with (partial) contributions from peer. "
-	"If {commitments_secured} is true, next call may be to splicechannel_finalize, "
-	"otherwise keep calling splice_update passing back in the returned PSBT until "
-	"{commitments_secured} is true."
 };
 AUTODATA(json_command, &splice_update_command);
 
 static const struct json_command splice_signed_command = {
 	"splice_signed",
 	json_splice_signed,
-	"Send our {signed_psbt}'s tx sigs for {channel_id}."
 };
 AUTODATA(json_command, &splice_signed_command);
 
@@ -2272,7 +2263,6 @@ static struct command_result *json_dev_feerate(struct command *cmd,
 static const struct json_command dev_feerate_command = {
 	"dev-feerate",
 	json_dev_feerate,
-	"Set feerate for {id} to {feerate}",
 	.dev_only = true,
 };
 AUTODATA(json_command, &dev_feerate_command);
@@ -2328,7 +2318,6 @@ static struct command_result *json_dev_quiesce(struct command *cmd,
 static const struct json_command dev_quiesce_command = {
 	"dev-quiesce",
 	json_dev_quiesce,
-	"Initiate quiscence protocol with peer",
 	.dev_only = true,
 };
 AUTODATA(json_command, &dev_quiesce_command);