mirrors/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2024-11-19 18:10:34 +01:00
Code Issues Projects Releases Wiki Activity

lnrpc: describe request replacement in API docs

Browse Source 
This commit updates the comments in the proto file to mention the new
behavior of also being able to replace request messages.
This commit is contained in:
Oliver Gugger 2022-07-06 21:16:58 +02:00 committed by Olaoluwa Osuntokun
parent 45c499a022
commit 179d1b8db5
3 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lnrpc/lightning.pb.go
View File

@ -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"`
}

10
lnrpc/lightning.proto
View File

@ -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;
}

4
lnrpc/lightning.swagger.json
View File

@ -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."
}
}
},