Skip to content

Commit 045e5cf

Browse files
committed
routerrpc: update QueryProbability documentation
Changes the docstring of QueryProbability to reflect changes that were introduced in lightningnetwork#6857.
1 parent b1d6991 commit 045e5cf

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

lnrpc/routerrpc/router.proto

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@ service Router {
9595

9696
/*
9797
Deprecated. QueryProbability returns the current success probability
98-
estimate for a given node pair and amount.
98+
estimate for a given node pair and amount. The call returns a zero success
99+
probability if no channel is available or if the amount violates min/max
100+
HTLC constraints.
99101
*/
100102
rpc QueryProbability (QueryProbabilityRequest)
101103
returns (QueryProbabilityResponse);

lnrpc/routerrpc/router.swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
},
117117
"/v2/router/mc/probability/{from_node}/{to_node}/{amt_msat}": {
118118
"get": {
119-
"summary": "Deprecated. QueryProbability returns the current success probability\nestimate for a given node pair and amount.",
119+
"summary": "Deprecated. QueryProbability returns the current success probability\nestimate for a given node pair and amount. The call returns a zero success\nprobability if no channel is available or if the amount violates min/max\nHTLC constraints.",
120120
"operationId": "Router_QueryProbability",
121121
"responses": {
122122
"200": {

lnrpc/routerrpc/router_grpc.pb.go

Lines changed: 6 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)