lnrpc: fix comment and formatting in ConnectPeerRequest [skip ci]

Fixes #6643.
This commit is contained in:
Oliver Gugger 2022-06-14 22:09:51 +02:00
parent 06710604fe
commit c492f367cd
No known key found for this signature in database
GPG key ID: 8E4256593F177720
3 changed files with 19 additions and 13 deletions

View file

@ -2931,10 +2931,10 @@ type LightningAddress struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
// The identity pubkey of the Lightning node // The identity pubkey of the Lightning node.
Pubkey string `protobuf:"bytes,1,opt,name=pubkey,proto3" json:"pubkey,omitempty"` Pubkey string `protobuf:"bytes,1,opt,name=pubkey,proto3" json:"pubkey,omitempty"`
// The network location of the lightning node, e.g. `69.69.69.69:1337` or // The network location of the lightning node, e.g. `69.69.69.69:1337` or
// `localhost:10011` // `localhost:10011`.
Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"` Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
} }
@ -3919,10 +3919,12 @@ type ConnectPeerRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
// Lightning address of the peer, in the format `<pubkey>@host` //
//Lightning address of the peer to connect to.
Addr *LightningAddress `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"` Addr *LightningAddress `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
// If set, the daemon will attempt to persistently connect to the target //
// peer. Otherwise, the call will be synchronous. //If set, the daemon will attempt to persistently connect to the target
//peer. Otherwise, the call will be synchronous.
Perm bool `protobuf:"varint,2,opt,name=perm,proto3" json:"perm,omitempty"` Perm bool `protobuf:"varint,2,opt,name=perm,proto3" json:"perm,omitempty"`
// //
//The connection timeout value (in seconds) for this request. It won't affect //The connection timeout value (in seconds) for this request. It won't affect

View file

@ -1008,11 +1008,11 @@ message OutPoint {
} }
message LightningAddress { message LightningAddress {
// The identity pubkey of the Lightning node // The identity pubkey of the Lightning node.
string pubkey = 1; string pubkey = 1;
// The network location of the lightning node, e.g. `69.69.69.69:1337` or // The network location of the lightning node, e.g. `69.69.69.69:1337` or
// `localhost:10011` // `localhost:10011`.
string host = 2; string host = 2;
} }
@ -1201,11 +1201,15 @@ message VerifyMessageResponse {
} }
message ConnectPeerRequest { message ConnectPeerRequest {
// Lightning address of the peer, in the format `<pubkey>@host` /*
Lightning address of the peer to connect to.
*/
LightningAddress addr = 1; LightningAddress addr = 1;
/* If set, the daemon will attempt to persistently connect to the target /*
* peer. Otherwise, the call will be synchronous. */ If set, the daemon will attempt to persistently connect to the target
peer. Otherwise, the call will be synchronous.
*/
bool perm = 2; bool perm = 2;
/* /*

View file

@ -3901,7 +3901,7 @@
"properties": { "properties": {
"addr": { "addr": {
"$ref": "#/definitions/lnrpcLightningAddress", "$ref": "#/definitions/lnrpcLightningAddress",
"title": "Lightning address of the peer, in the format `\u003cpubkey\u003e@host`" "description": "Lightning address of the peer to connect to."
}, },
"perm": { "perm": {
"type": "boolean", "type": "boolean",
@ -4935,11 +4935,11 @@
"properties": { "properties": {
"pubkey": { "pubkey": {
"type": "string", "type": "string",
"title": "The identity pubkey of the Lightning node" "description": "The identity pubkey of the Lightning node."
}, },
"host": { "host": {
"type": "string", "type": "string",
"title": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`" "description": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`."
} }
} }
}, },