Merge pull request #5916 from blastshielddown/docs_5899

lnrpc: add public key detail to signrpc KeyDescriptor [skip ci]
This commit is contained in:
Oliver Gugger 2021-11-02 15:03:14 +01:00 committed by GitHub
commit 32101db873
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 12 deletions

View File

@ -83,12 +83,12 @@ type KeyDescriptor struct {
unknownFields protoimpl.UnknownFields
//
//The raw bytes of the key being identified. Either this or the KeyLocator
//must be specified.
//The raw bytes of the public key in the key pair being identified. Either
//this or the KeyLocator must be specified.
RawKeyBytes []byte `protobuf:"bytes,1,opt,name=raw_key_bytes,json=rawKeyBytes,proto3" json:"raw_key_bytes,omitempty"`
//
//The key locator that identifies which key to use for signing. Either this
//or the raw bytes of the target key must be specified.
//The key locator that identifies which private key to use for signing.
//Either this or the raw bytes of the target public key must be specified.
KeyLoc *KeyLocator `protobuf:"bytes,2,opt,name=key_loc,json=keyLoc,proto3" json:"key_loc,omitempty"`
}

View File

@ -74,14 +74,14 @@ message KeyLocator {
message KeyDescriptor {
/*
The raw bytes of the key being identified. Either this or the KeyLocator
must be specified.
The raw bytes of the public key in the key pair being identified. Either
this or the KeyLocator must be specified.
*/
bytes raw_key_bytes = 1;
/*
The key locator that identifies which key to use for signing. Either this
or the raw bytes of the target key must be specified.
The key locator that identifies which private key to use for signing.
Either this or the raw bytes of the target public key must be specified.
*/
KeyLocator key_loc = 2;
}

View File

@ -253,11 +253,11 @@
"raw_key_bytes": {
"type": "string",
"format": "byte",
"description": "The raw bytes of the key being identified. Either this or the KeyLocator\nmust be specified."
"description": "The raw bytes of the public key in the key pair being identified. Either\nthis or the KeyLocator must be specified."
},
"key_loc": {
"$ref": "#/definitions/signrpcKeyLocator",
"description": "The key locator that identifies which key to use for signing. Either this\nor the raw bytes of the target key must be specified."
"description": "The key locator that identifies which private key to use for signing.\nEither this or the raw bytes of the target public key must be specified."
}
}
},

View File

@ -818,11 +818,11 @@
"raw_key_bytes": {
"type": "string",
"format": "byte",
"description": "The raw bytes of the key being identified. Either this or the KeyLocator\nmust be specified."
"description": "The raw bytes of the public key in the key pair being identified. Either\nthis or the KeyLocator must be specified."
},
"key_loc": {
"$ref": "#/definitions/signrpcKeyLocator",
"description": "The key locator that identifies which key to use for signing. Either this\nor the raw bytes of the target key must be specified."
"description": "The key locator that identifies which private key to use for signing.\nEither this or the raw bytes of the target public key must be specified."
}
}
},