From 372333fd2b941ed5a9c05337bfb3630ab11906f4 Mon Sep 17 00:00:00 2001 From: Tommy Volk Date: Sat, 14 May 2022 18:44:11 +0000 Subject: [PATCH] lnrpc: clarify proto documentation for Invoice --- lnrpc/invoicesrpc/invoices.swagger.json | 7 +++---- lnrpc/lightning.pb.go | 4 +++- lnrpc/lightning.proto | 4 +++- lnrpc/lightning.swagger.json | 7 +++---- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/lnrpc/invoicesrpc/invoices.swagger.json b/lnrpc/invoicesrpc/invoices.swagger.json index ff3294e70..6dee4c978 100644 --- a/lnrpc/invoicesrpc/invoices.swagger.json +++ b/lnrpc/invoicesrpc/invoices.swagger.json @@ -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", diff --git a/lnrpc/lightning.pb.go b/lnrpc/lightning.pb.go index fe97d362c..bde020073 100644 --- a/lnrpc/lightning.pb.go +++ b/lnrpc/lightning.pb.go @@ -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 diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index 73cb4f72b..031152d43 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -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; diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 24223fad1..32a718636 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -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",