docs: Removed null values from example request params

ElementsProject · Jun 19, 2024 · a4e7079 · a4e7079
1 parent ec25006
commit a4e7079
Show file tree

Hide file tree

Showing 47 changed files with 118 additions and 592 deletions.
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
diff --git a/doc/schemas/lightning-addpsbtoutput.json b/doc/schemas/lightning-addpsbtoutput.json
@@ -81,10 +81,7 @@
         "id": "example:addpsbtoutput#1",
         "method": "addpsbtoutput",
         "params": {
-          "satoshi": 100000,
-          "initialpsbt": null,
-          "locktime": null,
-          "destination": null
+          "satoshi": 100000
         }
       },
       "response": {
@@ -99,9 +96,7 @@
         "method": "addpsbtoutput",
         "params": {
           "satoshi": 1000000,
-          "initialpsbt": null,
-          "locktime": 111,
-          "destination": null
+          "locktime": 111
         }
       },
       "response": {
@@ -117,7 +112,6 @@
         "params": {
           "satoshi": 974343,
           "initialpsbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==",
-          "locktime": null,
           "destination": "bcrt1q9tc6q49l6wrrtp8ul45rj92hsleehwwxty32zu"
         }
       },

diff --git a/doc/schemas/lightning-autoclean-status.json b/doc/schemas/lightning-autoclean-status.json
@@ -436,9 +436,7 @@
       "request": {
         "id": "example:autoclean-status#2",
         "method": "autoclean-status",
-        "params": {
-          "subsystem": null
-        }
+        "params": {}
       },
       "response": {
         "autoclean": {

diff --git a/doc/schemas/lightning-check.json b/doc/schemas/lightning-check.json
@@ -47,14 +47,12 @@
           "route": [
             {
               "amount_msat": 1011,
-              "msatoshi": 1011,
               "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
               "delay": 20,
               "channel": "1x1x1"
             },
             {
               "amount_msat": 1000,
-              "msatoshi": 1000,
               "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
               "delay": 10,
               "channel": "2x2x2"

diff --git a/doc/schemas/lightning-checkmessage.json b/doc/schemas/lightning-checkmessage.json
@@ -80,8 +80,7 @@
         "method": "checkmessage",
         "params": {
           "message": "this is a test!",
-          "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7",
-          "pubkey": null
+          "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-close.json b/doc/schemas/lightning-close.json
@@ -150,11 +150,7 @@
         "method": "close",
         "params": {
           "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
-          "unilateraltimeout": 1,
-          "destination": null,
-          "fee_negotiation_step": null,
-          "force_lease_closed": null,
-          "feerange": null
+          "unilateraltimeout": 1
         }
       },
       "response": {
@@ -169,11 +165,7 @@
         "method": "close",
         "params": {
           "id": "103x1x0",
-          "unilateraltimeout": null,
-          "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg",
-          "fee_negotiation_step": null,
-          "force_lease_closed": null,
-          "feerange": null
+          "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-datastore.json b/doc/schemas/lightning-datastore.json
@@ -125,9 +125,7 @@
             "name"
           ],
           "string": "foobar",
-          "hex": null,
-          "mode": "must-replace",
-          "generation": null
+          "mode": "must-replace"
         }
       },
       "response": {
@@ -146,10 +144,8 @@
         "method": "datastore",
         "params": {
           "key": "somekey",
-          "string": null,
           "hex": "61",
-          "mode": "create-or-append",
-          "generation": null
+          "mode": "create-or-append"
         }
       },
       "response": {
@@ -173,10 +169,7 @@
             "f",
             "g"
           ],
-          "string": "somedatatostoreinthedatastore",
-          "hex": null,
-          "mode": null,
-          "generation": null
+          "string": "somedatatostoreinthedatastore"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-datastoreusage.json b/doc/schemas/lightning-datastoreusage.json
@@ -67,9 +67,7 @@
       "request": {
         "id": "example:datastoreusage#1",
         "method": "datastoreusage",
-        "params": {
-          "key": null
-        }
+        "params": {}
       },
       "response": {
         "datastoreusage": {

diff --git a/doc/schemas/lightning-decodepay.json b/doc/schemas/lightning-decodepay.json
@@ -253,8 +253,7 @@
         "id": "example:decodepay#1",
         "method": "decodepay",
         "params": {
-          "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk",
-          "description": null
+          "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-deldatastore.json b/doc/schemas/lightning-deldatastore.json
@@ -105,8 +105,7 @@
         "params": {
           "key": [
             "a"
-          ],
-          "generation": null
+          ]
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-delinvoice.json b/doc/schemas/lightning-delinvoice.json
@@ -304,8 +304,7 @@
         "method": "delinvoice",
         "params": {
           "label": "keysend-1708640419.666098582",
-          "status": "paid",
-          "desconly": null
+          "status": "paid"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-feerates.json b/doc/schemas/lightning-feerates.json
@@ -375,10 +375,7 @@
         "id": "example:feerates#1",
         "method": "feerates",
         "params": {
-          "style": "perkw",
-          "urgent": null,
-          "normal": null,
-          "slow": null
+          "style": "perkw"
         }
       },
       "response": {
@@ -429,10 +426,7 @@
         "id": "example:feerates#2",
         "method": "feerates",
         "params": {
-          "style": "perkb",
-          "urgent": null,
-          "normal": null,
-          "slow": null
+          "style": "perkb"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-fundchannel.json b/doc/schemas/lightning-fundchannel.json
@@ -229,16 +229,7 @@
         "params": {
           "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
           "amount": 1000000,
-          "feerate": null,
-          "announce": true,
-          "minconf": null,
-          "utxos": null,
-          "push_msat": null,
-          "close_to": null,
-          "request_amt": null,
-          "compact_lease": null,
-          "mindepth": null,
-          "reserve": null
+          "announce": true
         }
       },
       "response": {
@@ -255,17 +246,8 @@
         "params": {
           "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
           "amount": 10000000,
-          "feerate": null,
           "announce": true,
-          "minconf": null,
-          "utxos": null,
-          "push_msat": 1000000000,
-          "close_to": null,
-          "request_amt": null,
-          "compact_lease": null,
-          "mindepth": null,
-          "reserve": null,
-          "channel_type": null
+          "push_msat": 1000000000
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-fundchannel_start.json b/doc/schemas/lightning-fundchannel_start.json
@@ -195,10 +195,7 @@
         "params": {
           "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
           "amount": 16777216,
-          "feerate": null,
-          "announce": true,
-          "close_to": null,
-          "mindepth": null
+          "announce": true
         }
       },
       "response": {
@@ -214,11 +211,7 @@
         "params": {
           "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
           "amount": "100000sat",
-          "feerate": null,
-          "announce": true,
-          "close_to": null,
-          "mindepth": null,
-          "channel_type": null
+          "announce": true
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-fundpsbt.json b/doc/schemas/lightning-fundpsbt.json
@@ -204,10 +204,7 @@
           "satoshi": 16777216,
           "feerate": "253perkw",
           "startweight": 250,
-          "minconf": null,
           "reserve": 0,
-          "locktime": null,
-          "min_witness_weight": null,
           "excess_as_change": false
         }
       },
@@ -226,10 +223,6 @@
           "satoshi": "all",
           "feerate": "1000perkw",
           "startweight": 1000,
-          "minconf": null,
-          "reserve": null,
-          "locktime": null,
-          "min_witness_weight": null,
           "excess_as_change": false
         }
       },
@@ -258,10 +251,6 @@
           "satoshi": "109000sat",
           "feerate": "slow",
           "startweight": 166,
-          "minconf": null,
-          "reserve": null,
-          "locktime": null,
-          "min_witness_weight": null,
           "excess_as_change": true
         }
       },

diff --git a/doc/schemas/lightning-getroute.json b/doc/schemas/lightning-getroute.json
@@ -361,11 +361,7 @@
           "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518",
           "amount_msat": 50000000,
           "riskfactor": 1,
-          "cltv": 9,
-          "fromid": null,
-          "fuzzpercent": null,
-          "exclude": null,
-          "maxhops": null
+          "cltv": 9
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-invoice.json b/doc/schemas/lightning-invoice.json
@@ -198,13 +198,7 @@
           "label": "xEoCR94SIz6UIRUEkxum",
           "description": [
             "XEoCR94SIz6UIRUEkxum."
-          ],
-          "expiry": null,
-          "fallbacks": null,
-          "preimage": null,
-          "exposeprivatechannels": null,
-          "cltv": null,
-          "deschashonly": null
+          ]
         }
       },
       "response": {
@@ -223,13 +217,7 @@
         "params": {
           "amount_msat": 100,
           "label": "8",
-          "description": "inv",
-          "expiry": null,
-          "fallbacks": null,
-          "preimage": null,
-          "exposeprivatechannels": null,
-          "cltv": null,
-          "deschashonly": null
+          "description": "inv"
         }
       },
       "response": {

diff --git a/doc/schemas/lightning-keysend.json b/doc/schemas/lightning-keysend.json
@@ -216,13 +216,7 @@
         "method": "keysend",
         "params": {
           "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
-          "amount_msat": 10000,
-          "label": null,
-          "maxfeepercent": null,
-          "retry_for": null,
-          "maxdelay": null,
-          "exemptfee": null,
-          "extratlvs": null
+          "amount_msat": 10000
         }
       },
       "response": {
@@ -243,11 +237,6 @@
         "params": {
           "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518",
           "amount_msat": 10000000,
-          "label": null,
-          "maxfeepercent": null,
-          "retry_for": null,
-          "maxdelay": null,
-          "exemptfee": null,
           "extratlvs": {
             "133773310": "68656c6c6f776f726c64",
             "133773312": "66696c7465726d65"

diff --git a/doc/schemas/lightning-listchannels.json b/doc/schemas/lightning-listchannels.json
@@ -175,9 +175,7 @@
         "id": "example:listchannels#1",
         "method": "listchannels",
         "params": {
-          "short_channel_id": "103x1x0",
-          "source": null,
-          "destination": null
+          "short_channel_id": "103x1x0"
         }
       },
       "response": {
@@ -188,11 +186,7 @@
       "request": {
         "id": "example:listchannels#2",
         "method": "listchannels",
-        "params": {
-          "short_channel_id": null,
-          "source": null,
-          "destination": null
-        }
+        "params": {}
       },
       "response": {
         "channels": [

diff --git a/doc/schemas/lightning-listconfigs.json b/doc/schemas/lightning-listconfigs.json
@@ -2536,9 +2536,7 @@
       "request": {
         "id": "example:listconfigs#2",
         "method": "listconfigs",
-        "params": {
-          "config": null
-        }
+        "params": {}
       },
       "response": {
         "configs": {