From c0c0673356e3ec051575e3350a3c25afbcab9038 Mon Sep 17 00:00:00 2001 From: de6df1re Date: Thu, 10 Jun 2021 16:55:00 -0500 Subject: [PATCH] lnrpc: fix v1 switch API doc --- lnrpc/rpc.pb.go | 10 ++++++---- lnrpc/rpc.proto | 5 +++-- lnrpc/rpc.swagger.json | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/lnrpc/rpc.pb.go b/lnrpc/rpc.pb.go index 2eb06f56..9f836103 100644 --- a/lnrpc/rpc.pb.go +++ b/lnrpc/rpc.pb.go @@ -20123,8 +20123,9 @@ type LightningClient interface { // lncli: `fwdinghistory` //ForwardingHistory allows the caller to query the htlcswitch for a record of //all HTLCs forwarded within the target time range, and integer offset - //within that time range. If no time-range is specified, then the first chunk - //of the past 24 hrs of forwarding history are returned. + //within that time range, for a maximum number of events. If no maximum number + //of events is specified, up to 100 events will be returned. If no time-range + //is specified, then events will be returned in the order that they occured. // //A list of forwarding events are returned. The size of each forwarding event //is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB. @@ -21271,8 +21272,9 @@ type LightningServer interface { // lncli: `fwdinghistory` //ForwardingHistory allows the caller to query the htlcswitch for a record of //all HTLCs forwarded within the target time range, and integer offset - //within that time range. If no time-range is specified, then the first chunk - //of the past 24 hrs of forwarding history are returned. + //within that time range, for a maximum number of events. If no maximum number + //of events is specified, up to 100 events will be returned. If no time-range + //is specified, then events will be returned in the order that they occured. // //A list of forwarding events are returned. The size of each forwarding event //is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB. diff --git a/lnrpc/rpc.proto b/lnrpc/rpc.proto index 95afe2f9..d3754dbe 100644 --- a/lnrpc/rpc.proto +++ b/lnrpc/rpc.proto @@ -426,8 +426,9 @@ service Lightning { /* lncli: `fwdinghistory` ForwardingHistory allows the caller to query the htlcswitch for a record of all HTLCs forwarded within the target time range, and integer offset - within that time range. If no time-range is specified, then the first chunk - of the past 24 hrs of forwarding history are returned. + within that time range, for a maximum number of events. If no maximum number + of events is specified, up to 100 events will be returned. If no time-range + is specified, then events will be returned in the order that they occured. A list of forwarding events are returned. The size of each forwarding event is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB. diff --git a/lnrpc/rpc.swagger.json b/lnrpc/rpc.swagger.json index 97f50446..48bcebac 100644 --- a/lnrpc/rpc.swagger.json +++ b/lnrpc/rpc.swagger.json @@ -1984,7 +1984,7 @@ }, "/v1/switch": { "post": { - "summary": "lncli: `fwdinghistory`\nForwardingHistory allows the caller to query the htlcswitch for a record of\nall HTLCs forwarded within the target time range, and integer offset\nwithin that time range. If no time-range is specified, then the first chunk\nof the past 24 hrs of forwarding history are returned.", + "summary": "lncli: `fwdinghistory`\nForwardingHistory allows the caller to query the htlcswitch for a record of\nall HTLCs forwarded within the target time range, and integer offset\nwithin that time range, for a maximum number of events. If no maximum number\nof events is specified, up to 100 events will be returned. If no time-range\nis specified, then events will be returned in the order that they occured.", "description": "A list of forwarding events are returned. The size of each forwarding event\nis 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.\nAs a result each message can only contain 50k entries. Each response has\nthe index offset of the last entry. The index offset can be provided to the\nrequest to allow the caller to skip a series of records.", "operationId": "ForwardingHistory", "responses": {