Add RPC response message usage definition #158
Conversation
sophokles73
changed the title
|
|
||
| == Service Interface Design | ||
|
|
||
| uProtocol uses https://protobuf.dev/programming-guides/proto3/#services[Protobuf] for defining a service provider's operations. Based on the error model defined above, the _Protobuf Message_ defined/used as the response of an operation *SHOULD* only contain the data/information that represents the outcome of _successful_ execution of the operation. |
There was a problem hiding this comment.
| uProtocol uses https://protobuf.dev/programming-guides/proto3/#services[Protobuf] for defining a service provider's operations. Based on the error model defined above, the _Protobuf Message_ defined/used as the response of an operation *SHOULD* only contain the data/information that represents the outcome of _successful_ execution of the operation. | |
| uProtocol uses https://protobuf.dev/programming-guides/proto3/#services[Protobuf] for defining a service provider's operations. Based on the error model defined above, the _Protobuf Message_ defined/used as the response of an operation *SHOULD* only contain the data/information that represents the outcome of _successful_ execution of the operation. | |
| If a response message is not required to be returned by the method that was invoked, the rpc **SHOULD** declare that it returns `google.protobuf.Empty` that would mean there is no `UMessage.payload`. | |
| Example: `rpc DoSomething(DoSomethingRequest) returns (google.protobuf.Empty) {}` | |
There was a problem hiding this comment.
I have just read through Google's Protobuf API best practices and wonder, if we should instead suggest to define custom empty messages?
WDYT? @stevenhartley
There was a problem hiding this comment.
I think it is better that we define an empty per service like below and not a generic Empty message but I think that is what you mean:
rpc DoSomething(DoSomethingRequest) returns DoSomethingResponse {}
message DoSomethingRequest {
// A bunch of crap
}
message DoSomethingResponse {}
I would need to check what would then be in the UMessage.payload, a serialized empty message I guess (doesn't hurt)
There was a problem hiding this comment.
Yes, that is what I meant. IMHO this will also result in just an empty byte array, because the response message is defined exactly the same like google.protobuf.Empty.
I will update the spec accordingly ...
|
@stevenhartley do you also want me to change/update the core service protos accordingly, or do you want to do that in a separate PR? Technically, they should still be compliant with this updated spec, but IMHO we should change them nevertheless ... |
Separate PR is fine. |
Addresses #112