lnrpc: clarify proto documentation for Invoice

This commit is contained in:
Tommy Volk authored and yyforyongyu committed 2022-12-05 20:01:27 +08:00
1 parent 91c0a19807
commit 372333fd2b
4 files changed
+12 -10

No files matched your search

+3 -4
View File
@@ -469,18 +469,17 @@
},
"settled": {
"type": "boolean",
"description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
"title": "Whether this invoice has been fulfilled"
"description": "Whether this invoice has been fulfilled.\n\nThe field is deprecated. Use the state field instead (compare to SETTLED)."
},
"creation_date": {
"type": "string",
"format": "int64",
"description": "When this invoice was created.\nNote: Output only, don't specify for creating an invoice."
"description": "When this invoice was created.\nMeasured in seconds since the unix epoch.\nNote: Output only, don't specify for creating an invoice."
},
"settle_date": {
"type": "string",
"format": "int64",
"description": "When this invoice was settled.\nNote: Output only, don't specify for creating an invoice."
"description": "When this invoice was settled.\nMeasured in seconds since the unix epoch.\nNote: Output only, don't specify for creating an invoice."
},
"payment_request": {
"type": "string",
+3 -1
View File
@@ -11608,16 +11608,18 @@ type Invoice struct {
//
// The fields value and value_msat are mutually exclusive.
ValueMsat int64 `protobuf:"varint,23,opt,name=value_msat,json=valueMsat,proto3" json:"value_msat,omitempty"`
// Whether this invoice has been fulfilled
// Whether this invoice has been fulfilled.
//
// The field is deprecated. Use the state field instead (compare to SETTLED).
//
// Deprecated: Do not use.
Settled bool `protobuf:"varint,6,opt,name=settled,proto3" json:"settled,omitempty"`
// When this invoice was created.
// Measured in seconds since the unix epoch.
// Note: Output only, don't specify for creating an invoice.
CreationDate int64 `protobuf:"varint,7,opt,name=creation_date,json=creationDate,proto3" json:"creation_date,omitempty"`
// When this invoice was settled.
// Measured in seconds since the unix epoch.
// Note: Output only, don't specify for creating an invoice.
SettleDate int64 `protobuf:"varint,8,opt,name=settle_date,json=settleDate,proto3" json:"settle_date,omitempty"`
// A bare-bones invoice for a payment within the Lightning Network. With the
+3 -1
View File
@@ -3351,7 +3351,7 @@ message Invoice {
int64 value_msat = 23;
/*
Whether this invoice has been fulfilled
Whether this invoice has been fulfilled.
The field is deprecated. Use the state field instead (compare to SETTLED).
*/
@@ -3359,12 +3359,14 @@ message Invoice {
/*
When this invoice was created.
Measured in seconds since the unix epoch.
Note: Output only, don't specify for creating an invoice.
*/
int64 creation_date = 7;
/*
When this invoice was settled.
Measured in seconds since the unix epoch.
Note: Output only, don't specify for creating an invoice.
*/
int64 settle_date = 8;
+3 -4
View File
@@ -5003,18 +5003,17 @@
},
"settled": {
"type": "boolean",
"description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
"title": "Whether this invoice has been fulfilled"
"description": "Whether this invoice has been fulfilled.\n\nThe field is deprecated. Use the state field instead (compare to SETTLED)."
},
"creation_date": {
"type": "string",
"format": "int64",
"description": "When this invoice was created.\nNote: Output only, don't specify for creating an invoice."
"description": "When this invoice was created.\nMeasured in seconds since the unix epoch.\nNote: Output only, don't specify for creating an invoice."
},
"settle_date": {
"type": "string",
"format": "int64",
"description": "When this invoice was settled.\nNote: Output only, don't specify for creating an invoice."
"description": "When this invoice was settled.\nMeasured in seconds since the unix epoch.\nNote: Output only, don't specify for creating an invoice."
},
"payment_request": {
"type": "string",