lnrpc: add top level command doc tags to enable lncli api doc generation

This commit is contained in:
Keagan McClelland committed 2023-11-20 14:44:30 -07:00
1 parent ba4438b923
commit dae80f5db7
7 files changed
+17 -9

No files matched your search

+1 -1
View File
@@ -34,7 +34,7 @@ service Router {
*/
rpc SendPaymentV2 (SendPaymentRequest) returns (stream lnrpc.Payment);
/*
/* lncli: `trackpayment`
TrackPaymentV2 returns an update stream for the payment identified by the
payment hash.
*/
+1 -1
View File
@@ -434,7 +434,7 @@
},
"/v2/router/track/{payment_hash}": {
"get": {
"summary": "TrackPaymentV2 returns an update stream for the payment identified by the\npayment hash.",
"summary": "lncli: `trackpayment`\nTrackPaymentV2 returns an update stream for the payment identified by the\npayment hash.",
"operationId": "Router_TrackPaymentV2",
"responses": {
"200": {
+2
View File
@@ -23,6 +23,7 @@ type RouterClient interface {
// PaymentRequest to the final destination. The call returns a stream of
// payment updates.
SendPaymentV2(ctx context.Context, in *SendPaymentRequest, opts ...grpc.CallOption) (Router_SendPaymentV2Client, error)
// lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the
// payment hash.
TrackPaymentV2(ctx context.Context, in *TrackPaymentRequest, opts ...grpc.CallOption) (Router_TrackPaymentV2Client, error)
@@ -451,6 +452,7 @@ type RouterServer interface {
// PaymentRequest to the final destination. The call returns a stream of
// payment updates.
SendPaymentV2(*SendPaymentRequest, Router_SendPaymentV2Server) error
// lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the
// payment hash.
TrackPaymentV2(*TrackPaymentRequest, Router_TrackPaymentV2Server) error