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

This commit is contained in:
Keagan McClelland committed 2023-11-20 14:43:59 -07:00
1 parent 179295e441
commit 4eca04e6a0
3 files changed
+50 -12

No files matched your search

+6 -6
View File
@@ -18,7 +18,7 @@
"paths": {
"/v2/watchtower/client": {
"get": {
"summary": "ListTowers returns the list of watchtowers registered with the client.",
"summary": "lncli: `wtclient towers`\nListTowers returns the list of watchtowers registered with the client.",
"operationId": "WatchtowerClient_ListTowers",
"responses": {
"200": {
@@ -55,7 +55,7 @@
]
},
"post": {
"summary": "AddTower adds a new watchtower reachable at the given address and\nconsiders it for new sessions. If the watchtower already exists, then\nany new addresses included will be considered when dialing it for\nsession negotiations and backups.",
"summary": "lncli: `wtclient add`\nAddTower adds a new watchtower reachable at the given address and\nconsiders it for new sessions. If the watchtower already exists, then\nany new addresses included will be considered when dialing it for\nsession negotiations and backups.",
"operationId": "WatchtowerClient_AddTower",
"responses": {
"200": {
@@ -88,7 +88,7 @@
},
"/v2/watchtower/client/info/{pubkey}": {
"get": {
"summary": "GetTowerInfo retrieves information for a registered watchtower.",
"summary": "lncli: `wtclient tower`\nGetTowerInfo retrieves information for a registered watchtower.",
"operationId": "WatchtowerClient_GetTowerInfo",
"responses": {
"200": {
@@ -135,7 +135,7 @@
},
"/v2/watchtower/client/policy": {
"get": {
"summary": "Policy returns the active watchtower client policy configuration.",
"summary": "lncli: `wtclient policy`\nPolicy returns the active watchtower client policy configuration.",
"operationId": "WatchtowerClient_Policy",
"responses": {
"200": {
@@ -172,7 +172,7 @@
},
"/v2/watchtower/client/stats": {
"get": {
"summary": "Stats returns the in-memory statistics of the client since startup.",
"summary": "lncli: `wtclient stats`\nStats returns the in-memory statistics of the client since startup.",
"operationId": "WatchtowerClient_Stats",
"responses": {
"200": {
@@ -195,7 +195,7 @@
},
"/v2/watchtower/client/{pubkey}": {
"delete": {
"summary": "RemoveTower removes a watchtower from being considered for future session\nnegotiations and from being used for any subsequent backups until it's added\nagain. If an address is provided, then this RPC only serves as a way of\nremoving the address from the watchtower instead.",
"summary": "lncli: `wtclient remove`\nRemoveTower removes a watchtower from being considered for future session\nnegotiations and from being used for any subsequent backups until it's added\nagain. If an address is provided, then this RPC only serves as a way of\nremoving the address from the watchtower instead.",
"operationId": "WatchtowerClient_RemoveTower",
"responses": {
"200": {