Merge pull request #9215 from carlaKC/9166-docs

routerrpc/trivial: add docs to forward interceptor
lightningnetwork · Nov 1, 2024 · 006026f · 006026f
2 parents 891108d + 38bfe1b
commit 006026f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/lnrpc/routerrpc/router.pb.go b/lnrpc/routerrpc/router.pb.go
diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto
@@ -1063,6 +1063,14 @@ message ForwardHtlcInterceptResponse {
     // Any custom records that should be set on the p2p wire message message of
     // the resumed HTLC. This field is ignored if the action is not
     // RESUME_MODIFIED.
+    //
+    // If this map is populated, it will overwrite any of the wire custom
+    // records set by LND. It is the caller's responsibility to copy any desired
+    // records across. If the map is empty, no action will be taken and existing
+    // custom records will be propagated.
+    //
+    // The API does not currently support deleting custom records, unless they
+    // are overwritten by a new set.
     map<uint64, bytes> out_wire_custom_records = 8;
 }
 

diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json
@@ -1525,7 +1525,7 @@
             "type": "string",
             "format": "byte"
           },
-          "description": "Any custom records that should be set on the p2p wire message message of\nthe resumed HTLC. This field is ignored if the action is not\nRESUME_MODIFIED."
+          "description": "Any custom records that should be set on the p2p wire message message of\nthe resumed HTLC. This field is ignored if the action is not\nRESUME_MODIFIED.\n\nIf this map is populated, it will overwrite any of the wire custom\nrecords set by LND. It is the caller's responsibility to copy any desired\nrecords across. If the map is empty, no action will be taken and existing\ncustom records will be propagated.\n\nThe API does not currently support deleting custom records, unless they\nare overwritten by a new set."
         }
       },
       "description": "*\nForwardHtlcInterceptResponse enables the caller to resolve a previously hold\nforward. The caller can choose either to:\n- `Resume`: Execute the default behavior (usually forward).\n- `ResumeModified`: Execute the default behavior (usually forward) with HTLC\nfield modifications.\n- `Reject`: Fail the htlc backwards.\n- `Settle`: Settle this htlc with a given preimage."