devrpc: remove lncli API docs tag [skip ci]

The API doc generator failed after merging #6149 because of the `lncli
importgraph` tag in the proto file.
We could also fix the API doc generator by adding the "dev" build tag,
but not including any dev only features in the API docs is probably the
preferred path.
This commit is contained in:
Oliver Gugger 2022-01-31 13:03:26 +01:00
parent 8d40c8904e
commit a5849bb189
No known key found for this signature in database
GPG Key ID: 8E4256593F177720
3 changed files with 4 additions and 4 deletions

View File

@ -7,7 +7,7 @@ package devrpc;
option go_package = "github.com/lightningnetwork/lnd/lnrpc/devrpc";
service Dev {
/* lncli: `importgraph`
/*
ImportGraph imports a ChannelGraph into the graph database. Should only be
used for development.
*/

View File

@ -18,7 +18,7 @@
"paths": {
"/v2/dev/importgraph": {
"post": {
"summary": "lncli: `importgraph`\nImportGraph imports a ChannelGraph into the graph database. Should only be\nused for development.",
"summary": "ImportGraph imports a ChannelGraph into the graph database. Should only be\nused for development.",
"operationId": "Dev_ImportGraph",
"responses": {
"200": {

View File

@ -19,7 +19,7 @@ const _ = grpc.SupportPackageIsVersion7
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type DevClient interface {
// lncli: `importgraph`
//
//ImportGraph imports a ChannelGraph into the graph database. Should only be
//used for development.
ImportGraph(ctx context.Context, in *lnrpc.ChannelGraph, opts ...grpc.CallOption) (*ImportGraphResponse, error)
@ -46,7 +46,7 @@ func (c *devClient) ImportGraph(ctx context.Context, in *lnrpc.ChannelGraph, opt
// All implementations must embed UnimplementedDevServer
// for forward compatibility
type DevServer interface {
// lncli: `importgraph`
//
//ImportGraph imports a ChannelGraph into the graph database. Should only be
//used for development.
ImportGraph(context.Context, *lnrpc.ChannelGraph) (*ImportGraphResponse, error)