From d604055ccceea6d06ce673e29e998133000afbbe Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Wed, 6 Jul 2022 21:16:58 +0200 Subject: [PATCH] lnrpc: describe request replacement in API docs This commit updates the comments in the proto file to mention the new behavior of also being able to replace request messages. --- lnrpc/lightning.pb.go | 10 ++++------ lnrpc/lightning.proto | 10 ++++------ lnrpc/lightning.swagger.json | 4 ++-- 3 files changed, 10 insertions(+), 14 deletions(-) diff --git a/lnrpc/lightning.pb.go b/lnrpc/lightning.pb.go index 25e9e6222..a80f76b8e 100644 --- a/lnrpc/lightning.pb.go +++ b/lnrpc/lightning.pb.go @@ -16206,16 +16206,14 @@ type InterceptFeedback struct { //response and the processing of it can continue. Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` // - //A boolean indicating that the gRPC response should be replaced/overwritten. - //As its name suggests, this can only be used as a feedback to an intercepted - //response RPC message and is ignored for feedback on any other message. This - //boolean is needed because in protobuf an empty message is serialized as a - //0-length or nil byte slice and we wouldn't be able to distinguish between + //A boolean indicating that the gRPC message should be replaced/overwritten. + //This boolean is needed because in protobuf an empty message is serialized as + //a 0-length or nil byte slice and we wouldn't be able to distinguish between //an empty replacement message and the "don't replace anything" case. ReplaceResponse bool `protobuf:"varint,2,opt,name=replace_response,json=replaceResponse,proto3" json:"replace_response,omitempty"` // //If the replace_response field is set to true, this field must contain the - //binary serialized gRPC response message in the protobuf format. + //binary serialized gRPC message in the protobuf format. ReplacementSerialized []byte `protobuf:"bytes,3,opt,name=replacement_serialized,json=replacementSerialized,proto3" json:"replacement_serialized,omitempty"` } diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index e65e3f6eb..44b5b88e5 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -4501,18 +4501,16 @@ message InterceptFeedback { string error = 1; /* - A boolean indicating that the gRPC response should be replaced/overwritten. - As its name suggests, this can only be used as a feedback to an intercepted - response RPC message and is ignored for feedback on any other message. This - boolean is needed because in protobuf an empty message is serialized as a - 0-length or nil byte slice and we wouldn't be able to distinguish between + A boolean indicating that the gRPC message should be replaced/overwritten. + This boolean is needed because in protobuf an empty message is serialized as + a 0-length or nil byte slice and we wouldn't be able to distinguish between an empty replacement message and the "don't replace anything" case. */ bool replace_response = 2; /* If the replace_response field is set to true, this field must contain the - binary serialized gRPC response message in the protobuf format. + binary serialized gRPC message in the protobuf format. */ bytes replacement_serialized = 3; } diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 6fdd36bd1..0ff50ed16 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -4682,12 +4682,12 @@ }, "replace_response": { "type": "boolean", - "description": "A boolean indicating that the gRPC response should be replaced/overwritten.\nAs its name suggests, this can only be used as a feedback to an intercepted\nresponse RPC message and is ignored for feedback on any other message. This\nboolean is needed because in protobuf an empty message is serialized as a\n0-length or nil byte slice and we wouldn't be able to distinguish between\nan empty replacement message and the \"don't replace anything\" case." + "description": "A boolean indicating that the gRPC message should be replaced/overwritten.\nThis boolean is needed because in protobuf an empty message is serialized as\na 0-length or nil byte slice and we wouldn't be able to distinguish between\nan empty replacement message and the \"don't replace anything\" case." }, "replacement_serialized": { "type": "string", "format": "byte", - "description": "If the replace_response field is set to true, this field must contain the\nbinary serialized gRPC response message in the protobuf format." + "description": "If the replace_response field is set to true, this field must contain the\nbinary serialized gRPC message in the protobuf format." } } },