looprpc: document missing CLI commands

pull/403/head
Oliver Gugger 3 years ago
parent 86df44362f
commit 77f7b73570
No known key found for this signature in database
GPG Key ID: 8E4256593F177720

@ -3393,18 +3393,18 @@ type SwapClientClient interface {
// loop: `listauth` // loop: `listauth`
//GetLsatTokens returns all LSAT tokens the daemon ever paid for. //GetLsatTokens returns all LSAT tokens the daemon ever paid for.
GetLsatTokens(ctx context.Context, in *TokensRequest, opts ...grpc.CallOption) (*TokensResponse, error) GetLsatTokens(ctx context.Context, in *TokensRequest, opts ...grpc.CallOption) (*TokensResponse, error)
// // loop: `getparams`
//GetLiquidityParams gets the parameters that the daemon's liquidity manager //GetLiquidityParams gets the parameters that the daemon's liquidity manager
//is currently configured with. This may be nil if nothing is configured. //is currently configured with. This may be nil if nothing is configured.
//[EXPERIMENTAL]: endpoint is subject to change. //[EXPERIMENTAL]: endpoint is subject to change.
GetLiquidityParams(ctx context.Context, in *GetLiquidityParamsRequest, opts ...grpc.CallOption) (*LiquidityParameters, error) GetLiquidityParams(ctx context.Context, in *GetLiquidityParamsRequest, opts ...grpc.CallOption) (*LiquidityParameters, error)
// // loop: `setparams`
//SetLiquidityParams sets a new set of parameters for the daemon's liquidity //SetLiquidityParams sets a new set of parameters for the daemon's liquidity
//manager. Note that the full set of parameters must be provided, because //manager. Note that the full set of parameters must be provided, because
//this call fully overwrites our existing parameters. //this call fully overwrites our existing parameters.
//[EXPERIMENTAL]: endpoint is subject to change. //[EXPERIMENTAL]: endpoint is subject to change.
SetLiquidityParams(ctx context.Context, in *SetLiquidityParamsRequest, opts ...grpc.CallOption) (*SetLiquidityParamsResponse, error) SetLiquidityParams(ctx context.Context, in *SetLiquidityParamsRequest, opts ...grpc.CallOption) (*SetLiquidityParamsResponse, error)
// // loop: `suggestswaps`
//SuggestSwaps returns a list of recommended swaps based on the current //SuggestSwaps returns a list of recommended swaps based on the current
//state of your node's channels and it's liquidity manager parameters. //state of your node's channels and it's liquidity manager parameters.
//Note that only loop out suggestions are currently supported. //Note that only loop out suggestions are currently supported.
@ -3600,18 +3600,18 @@ type SwapClientServer interface {
// loop: `listauth` // loop: `listauth`
//GetLsatTokens returns all LSAT tokens the daemon ever paid for. //GetLsatTokens returns all LSAT tokens the daemon ever paid for.
GetLsatTokens(context.Context, *TokensRequest) (*TokensResponse, error) GetLsatTokens(context.Context, *TokensRequest) (*TokensResponse, error)
// // loop: `getparams`
//GetLiquidityParams gets the parameters that the daemon's liquidity manager //GetLiquidityParams gets the parameters that the daemon's liquidity manager
//is currently configured with. This may be nil if nothing is configured. //is currently configured with. This may be nil if nothing is configured.
//[EXPERIMENTAL]: endpoint is subject to change. //[EXPERIMENTAL]: endpoint is subject to change.
GetLiquidityParams(context.Context, *GetLiquidityParamsRequest) (*LiquidityParameters, error) GetLiquidityParams(context.Context, *GetLiquidityParamsRequest) (*LiquidityParameters, error)
// // loop: `setparams`
//SetLiquidityParams sets a new set of parameters for the daemon's liquidity //SetLiquidityParams sets a new set of parameters for the daemon's liquidity
//manager. Note that the full set of parameters must be provided, because //manager. Note that the full set of parameters must be provided, because
//this call fully overwrites our existing parameters. //this call fully overwrites our existing parameters.
//[EXPERIMENTAL]: endpoint is subject to change. //[EXPERIMENTAL]: endpoint is subject to change.
SetLiquidityParams(context.Context, *SetLiquidityParamsRequest) (*SetLiquidityParamsResponse, error) SetLiquidityParams(context.Context, *SetLiquidityParamsRequest) (*SetLiquidityParamsResponse, error)
// // loop: `suggestswaps`
//SuggestSwaps returns a list of recommended swaps based on the current //SuggestSwaps returns a list of recommended swaps based on the current
//state of your node's channels and it's liquidity manager parameters. //state of your node's channels and it's liquidity manager parameters.
//Note that only loop out suggestions are currently supported. //Note that only loop out suggestions are currently supported.

@ -67,7 +67,7 @@ service SwapClient {
*/ */
rpc GetLsatTokens (TokensRequest) returns (TokensResponse); rpc GetLsatTokens (TokensRequest) returns (TokensResponse);
/* /* loop: `getparams`
GetLiquidityParams gets the parameters that the daemon's liquidity manager GetLiquidityParams gets the parameters that the daemon's liquidity manager
is currently configured with. This may be nil if nothing is configured. is currently configured with. This may be nil if nothing is configured.
[EXPERIMENTAL]: endpoint is subject to change. [EXPERIMENTAL]: endpoint is subject to change.
@ -75,7 +75,7 @@ service SwapClient {
rpc GetLiquidityParams (GetLiquidityParamsRequest) rpc GetLiquidityParams (GetLiquidityParamsRequest)
returns (LiquidityParameters); returns (LiquidityParameters);
/* /* loop: `setparams`
SetLiquidityParams sets a new set of parameters for the daemon's liquidity SetLiquidityParams sets a new set of parameters for the daemon's liquidity
manager. Note that the full set of parameters must be provided, because manager. Note that the full set of parameters must be provided, because
this call fully overwrites our existing parameters. this call fully overwrites our existing parameters.
@ -84,7 +84,7 @@ service SwapClient {
rpc SetLiquidityParams (SetLiquidityParamsRequest) rpc SetLiquidityParams (SetLiquidityParamsRequest)
returns (SetLiquidityParamsResponse); returns (SetLiquidityParamsResponse);
/* /* loop: `suggestswaps`
SuggestSwaps returns a list of recommended swaps based on the current SuggestSwaps returns a list of recommended swaps based on the current
state of your node's channels and it's liquidity manager parameters. state of your node's channels and it's liquidity manager parameters.
Note that only loop out suggestions are currently supported. Note that only loop out suggestions are currently supported.

@ -13,7 +13,7 @@
"paths": { "paths": {
"/v1/auto/suggest": { "/v1/auto/suggest": {
"get": { "get": {
"summary": "SuggestSwaps returns a list of recommended swaps based on the current\nstate of your node's channels and it's liquidity manager parameters.\nNote that only loop out suggestions are currently supported.\n[EXPERIMENTAL]: endpoint is subject to change.", "summary": "loop: `suggestswaps`\nSuggestSwaps returns a list of recommended swaps based on the current\nstate of your node's channels and it's liquidity manager parameters.\nNote that only loop out suggestions are currently supported.\n[EXPERIMENTAL]: endpoint is subject to change.",
"operationId": "SuggestSwaps", "operationId": "SuggestSwaps",
"responses": { "responses": {
"200": { "200": {
@ -36,7 +36,7 @@
}, },
"/v1/liquidity/params": { "/v1/liquidity/params": {
"get": { "get": {
"summary": "GetLiquidityParams gets the parameters that the daemon's liquidity manager\nis currently configured with. This may be nil if nothing is configured.\n[EXPERIMENTAL]: endpoint is subject to change.", "summary": "loop: `getparams`\nGetLiquidityParams gets the parameters that the daemon's liquidity manager\nis currently configured with. This may be nil if nothing is configured.\n[EXPERIMENTAL]: endpoint is subject to change.",
"operationId": "GetLiquidityParams", "operationId": "GetLiquidityParams",
"responses": { "responses": {
"200": { "200": {
@ -57,7 +57,7 @@
] ]
}, },
"post": { "post": {
"summary": "SetLiquidityParams sets a new set of parameters for the daemon's liquidity\nmanager. Note that the full set of parameters must be provided, because\nthis call fully overwrites our existing parameters.\n[EXPERIMENTAL]: endpoint is subject to change.", "summary": "loop: `setparams`\nSetLiquidityParams sets a new set of parameters for the daemon's liquidity\nmanager. Note that the full set of parameters must be provided, because\nthis call fully overwrites our existing parameters.\n[EXPERIMENTAL]: endpoint is subject to change.",
"operationId": "SetLiquidityParams", "operationId": "SetLiquidityParams",
"responses": { "responses": {
"200": { "200": {

Loading…
Cancel
Save