From 2be7433ae6c9ed6bfdfde5b9dc0aa929f40c7d01 Mon Sep 17 00:00:00 2001
From: Aditya Sharma <aditya.sharma.met19@itbhu.ac.in>
Date: Thu, 8 Aug 2024 11:19:25 +0530
Subject: [PATCH] doc: Add documentation for the RPC getemergencyrecoverdata.

---
 contrib/msggen/msggen/schema.json             | 48 +++++++++++++++++++
 doc/Makefile                                  |  1 +
 doc/index.rst                                 |  1 +
 .../lightning-getemergencyrecoverdata.json    | 48 +++++++++++++++++++
 4 files changed, 98 insertions(+)
 create mode 100644 doc/schemas/lightning-getemergencyrecoverdata.json

diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
index 7db584550..66058efe5 100644
--- a/contrib/msggen/msggen/schema.json
+++ b/contrib/msggen/msggen/schema.json
@@ -13430,6 +13430,54 @@
         }
       ]
     },
+    "lightning-getemergencyrecoverdata.json": {
+      "$schema": "../rpc-schema-draft.json",
+      "type": "object",
+      "additionalProperties": false,
+      "rpc": "getemergencyrecoverdata",
+      "title": "Command to fetch data from the emergency.recover file",
+      "description": [
+        "The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
+      ],
+      "request": {
+        "required": [],
+        "properties": {}
+      },
+      "response": {
+        "required": [
+          "filedata"
+        ],
+        "properties": {
+          "filedata": {
+            "type": "hex",
+            "description": [
+              "The raw, hex-encoded, emergency.recover file"
+            ]
+          }
+        }
+      },
+      "author": [
+        "Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
+      ],
+      "see_also": [
+        "lightning-getsharedsecret(7)"
+      ],
+      "resources": [
+        "Main web site: <https://github.com/ElementsProject/lightning>"
+      ],
+      "examples": [
+        {
+          "request": {
+            "id": "example:getemergencyrecoverdata#1",
+            "method": "getemergencyrecoverdata",
+            "params": {}
+          },
+          "response": {
+            "filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
+          }
+        }
+      ]
+    },
     "lightning-getinfo.json": {
       "$schema": "../rpc-schema-draft.json",
       "type": "object",
diff --git a/doc/Makefile b/doc/Makefile
index b7b7648ed..ccae17e9e 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -60,6 +60,7 @@ GENERATE_MARKDOWN := doc/lightning-addgossip.7 \
 	doc/lightning-fundchannel_start.7 \
 	doc/lightning-funderupdate.7 \
 	doc/lightning-fundpsbt.7 \
+	doc/lightning-getemergencyrecoverdata.7 \
 	doc/lightning-getinfo.7 \
 	doc/lightning-getlog.7 \
 	doc/lightning-getroute.7 \
diff --git a/doc/index.rst b/doc/index.rst
index edee2e109..bb48bce62 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -69,6 +69,7 @@ Core Lightning Documentation
    lightning-fundchannel_start <lightning-fundchannel_start.7.md>
    lightning-funderupdate <lightning-funderupdate.7.md>
    lightning-fundpsbt <lightning-fundpsbt.7.md>
+   lightning-getemergencyrecoverdata <lightning-getemergencyrecoverdata.7.md>
    lightning-getinfo <lightning-getinfo.7.md>
    lightning-getlog <lightning-getlog.7.md>
    lightning-getroute <lightning-getroute.7.md>
diff --git a/doc/schemas/lightning-getemergencyrecoverdata.json b/doc/schemas/lightning-getemergencyrecoverdata.json
new file mode 100644
index 000000000..3fc4bee3d
--- /dev/null
+++ b/doc/schemas/lightning-getemergencyrecoverdata.json
@@ -0,0 +1,48 @@
+{
+  "$schema": "../rpc-schema-draft.json",
+  "type": "object",
+  "additionalProperties": false,
+  "rpc": "getemergencyrecoverdata",
+  "title": "Command to fetch data from the emergency.recover file",
+  "description": [
+    "The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
+  ],
+  "request": {
+    "required": [],
+    "properties": {}
+  },
+  "response": {
+    "required": [
+      "filedata"
+    ],
+    "properties": {
+      "filedata": {
+        "type": "hex",
+        "description": [
+          "The raw, hex-encoded, emergency.recover file"
+        ]
+      }
+    }
+  },
+  "author": [
+    "Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
+  ],
+  "see_also": [
+    "lightning-getsharedsecret(7)"
+  ],
+  "resources": [
+    "Main web site: <https://github.com/ElementsProject/lightning>"
+  ],
+  "examples": [
+    {
+      "request": {
+        "id": "example:getemergencyrecoverdata#1",
+        "method": "getemergencyrecoverdata",
+        "params": {}
+      },
+      "response": {
+        "filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
+      }
+    }
+  ]
+}