highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-09-09 18:52:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Keagan McClelland
2023-11-14 16:58:14 -08:00
parent c0da9ca1b0
commit b855566e6b
3 changed files with 26 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
lnrpc/autopilotrpc/autopilot.proto
View File

@@ -4,11 +4,29 @@ package autopilotrpc;
option go_package = "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc";
/*
* Comments in this file will be directly parsed into the API
* Documentation as descriptions of the associated method, message, or field.
* These descriptions should go right above the definition of the object, and
* can be in either block or // comment format.
*
* An RPC method can be matched to an lncli command by placing a line in the
* beginning of the description in exactly the following format:
* lncli: `methodname`
*
* Failure to specify the exact name of the command will cause documentation
* generation to fail.
*
* More information on how exactly the gRPC documentation is generated from
* this proto file can be found here:
* https://github.com/lightninglabs/lightning-api
*/
// Autopilot is a service that can be used to get information about the current
// state of the daemon's autopilot agent, and also supply it with information
// that can be used when deciding where to open channels.
service Autopilot {
/*
/* lncli: `autopilot status`
Status returns whether the daemon's autopilot agent is active.
*/
rpc Status (StatusRequest) returns (StatusResponse);
@@ -19,7 +37,7 @@ service Autopilot {
*/
rpc ModifyStatus (ModifyStatusRequest) returns (ModifyStatusResponse);
/*
/* lncli: `autopilot query`
QueryScores queries all available autopilot heuristics, in addition to any
active combination of these heruristics, for the scores they would give to
the given nodes.