askrene: add autogenated schema and doc files

Signed-off-by: Lagrang3 <lagrang3@protonmail.com>
ElementsProject · Sep 26, 2024 · 1b02f8a · 1b02f8a
1 parent b771fa7
commit 1b02f8a
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 0 deletions.
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
@@ -703,6 +703,88 @@
         "Main web site: <https://github.com/ElementsProject/lightning>"
       ]
     },
+    "lightning-askrene-query-reserve.json": {
+      "$schema": "../rpc-schema-draft.json",
+      "type": "object",
+      "additionalProperties": false,
+      "rpc": "askrene-query-reserve",
+      "title": "Command to query the reserved liquidity in a channel (EXPERIMENTAL)",
+      "description": [
+        "WARNING: experimental, so API may change.",
+        "",
+        "The **askrene-query-reserve** RPC command provides information about the number of in-flight HTLCs in a channel and the sum of their respective amounts."
+      ],
+      "request": {
+        "required": [
+          "short_channel_id",
+          "direction"
+        ],
+        "properties": {
+          "short_channel_id": {
+            "type": "short_channel_id",
+            "description": [
+              "The short channel id of the channel."
+            ]
+          },
+          "direction": {
+            "type": "u32",
+            "description": [
+              "The direction of the channel."
+            ]
+          }
+        }
+      },
+      "response": {
+        "required": [
+          "short_channel_id",
+          "direction",
+          "num_htlcs",
+          "amount_msat"
+        ],
+        "properties": {
+          "short_channel_id": {
+            "type": "short_channel_id",
+            "description": [
+              "The *short_channel_id* specified."
+            ]
+          },
+          "direction": {
+            "type": "u32",
+            "description": [
+              "The *direction* specified."
+            ]
+          },
+          "num_htlcs": {
+            "type": "u32",
+            "description": [
+              "The number of HTLCs in-flight in the channel."
+            ]
+          },
+          "amount_msat": {
+            "type": "msat",
+            "description": [
+              "The total amount reserved in the channel."
+            ]
+          }
+        }
+      },
+      "see_also": [
+        "lightning-getroutes(7)",
+        "lightning-askrene-reserve(7)",
+        "lightning-askrene-unreserve(7)",
+        "lightning-askrene-inform-channel(7)",
+        "lightning-askrene-disable-node(7)",
+        "lightning-askrene-create-channel(7)",
+        "lightning-askrene-listlayers(7)",
+        "lightning-askrene-age(7)"
+      ],
+      "author": [
+        "Lagrang3 <<lagrang3@protonmail.com>> is mainly responsible."
+      ],
+      "resources": [
+        "Main web site: <https://github.com/ElementsProject/lightning>"
+      ]
+    },
     "lightning-askrene-reserve.json": {
       "$schema": "../rpc-schema-draft.json",
       "type": "object",
@@ -762,6 +844,7 @@
       "see_also": [
         "lightning-getroutes(7)",
         "lightning-askrene-unreserve(7)",
+        "lightning-askrene-query-reserve(7)",
         "lightning-askrene-disable-node(7)",
         "lightning-askrene-create-channel(7)",
         "lightning-askrene-inform-channel(7)",
@@ -834,6 +917,7 @@
       "see_also": [
         "lightning-getroutes(7)",
         "lightning-askrene-reserve(7)",
+        "lightning-askrene-query-reserve(7)",
         "lightning-askrene-disable-node(7)",
         "lightning-askrene-create-channel(7)",
         "lightning-askrene-inform-channel(7)",

diff --git a/doc/index.rst b/doc/index.rst
@@ -18,6 +18,7 @@ Core Lightning Documentation
    lightning-askrene-disable-node <lightning-askrene-disable-node.7.md>
    lightning-askrene-inform-channel <lightning-askrene-inform-channel.7.md>
    lightning-askrene-listlayers <lightning-askrene-listlayers.7.md>
+   lightning-askrene-query-reserve <lightning-askrene-query-reserve.7.md>
    lightning-askrene-reserve <lightning-askrene-reserve.7.md>
    lightning-askrene-unreserve <lightning-askrene-unreserve.7.md>
    lightning-autoclean-once <lightning-autoclean-once.7.md>