lnrpc: add invoicesrpc doc tags to enable lncli api doc generation

This commit is contained in:
Keagan McClelland committed 2023-11-20 14:41:54 -07:00
1 parent b855566e6b
commit bba09e320c
3 files changed
+30 -6

No files matched your search

+3 -3
View File
@@ -18,7 +18,7 @@
"paths": {
"/v2/invoices/cancel": {
"post": {
"summary": "CancelInvoice cancels a currently open invoice. If the invoice is already\ncanceled, this call will succeed. If the invoice is already settled, it will\nfail.",
"summary": "lncli: `cancelinvoice`\nCancelInvoice cancels a currently open invoice. If the invoice is already\ncanceled, this call will succeed. If the invoice is already settled, it will\nfail.",
"operationId": "Invoices_CancelInvoice",
"responses": {
"200": {
@@ -51,7 +51,7 @@
},
"/v2/invoices/hodl": {
"post": {
"summary": "AddHoldInvoice creates a hold invoice. It ties the invoice to the hash\nsupplied in the request.",
"summary": "lncli: `addholdinvoice`\nAddHoldInvoice creates a hold invoice. It ties the invoice to the hash\nsupplied in the request.",
"operationId": "Invoices_AddHoldInvoice",
"responses": {
"200": {
@@ -144,7 +144,7 @@
},
"/v2/invoices/settle": {
"post": {
"summary": "SettleInvoice settles an accepted invoice. If the invoice is already\nsettled, this call will succeed.",
"summary": "lncli: `settleinvoice`\nSettleInvoice settles an accepted invoice. If the invoice is already\nsettled, this call will succeed.",
"operationId": "Invoices_SettleInvoice",
"responses": {
"200": {