Merge pull request #6748 from Kixunil/patch-3

guggero · web-flow · commit e86a69b815de · 2022-08-02T12:38:08.000+02:00
doc: Deprecation reason of `settled` on `Invoice`
diff --git a/lnrpc/invoicesrpc/invoices.swagger.json b/lnrpc/invoicesrpc/invoices.swagger.json
@@ -469,6 +469,7 @@
         },
         "settled": {
           "type": "boolean",
+          "description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
           "title": "Whether this invoice has been fulfilled"
         },
         "creation_date": {
diff --git a/lnrpc/lightning.pb.go b/lnrpc/lightning.pb.go
diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto
@@ -3227,7 +3227,11 @@ message Invoice {
     */
     int64 value_msat = 23;
 
-    // Whether this invoice has been fulfilled
+    /*
+    Whether this invoice has been fulfilled
+
+    The field is deprecated. Use the state field instead (compare to SETTLED).
+    */
     bool settled = 6 [deprecated = true];
 
     /*
diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json
@@ -4722,6 +4722,7 @@
         },
         "settled": {
           "type": "boolean",
+          "description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
           "title": "Whether this invoice has been fulfilled"
         },
         "creation_date": {
