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.
This commit is contained in:
Oliver Gugger
2022-07-06 21:16:58 +02:00
parent 86c64abfe6
commit d604055ccc
3 changed files with 10 additions and 14 deletions

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