Rename RPC parameters to be more consistent with the RPC names #150
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
Closed
| TargetMetric target_metric = 2; | ||
| // Request parameters for the RPC `HotStandbyComponent`. | ||
| message HotStandbyComponentRequest { | ||
| // The component ID to. |
There was a problem hiding this comment.
Nitpick: The component ID to what?
Here and below :)
There was a problem hiding this comment.
oops 🙈
Fixed!
The RPC parameters were named in a way that was not consistent with the RPC names. This commit renames the RPC parameters to be more consistent with the RPC names. The following rules have been followed, in order: 1. If an RPC is named `GetX`, then its request message is named `GetXRequest` and its response message is named `X`. Same for `SubscribeX`. 2. If an RPC is named `VerbX`, then its request message is named `VerbXRequest`. Its response message is named `VerbXResponse`, unless the response type is `google.protobuf.Empty`. Also, the documentation in the proto files has been updated to be more consistent with each other. Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
tiyash-basu-frequenz
force-pushed
the
rename_rpc_params
branch
from
deaab1f
to
5129f5d
Compare
stefan-brus-frequenz
approved these changes
Oct 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The RPC parameters were named in a way that was not consistent with the RPC names. This commit renames the RPC parameters to be more consistent with the RPC names. The following rules have been followed, in order:
GetX, then its request message is namedGetXRequestand its response message is namedX. Same forSubscribeX.VerbX, then its request message is namedVerbXRequest. Its response message is namedVerbXResponse, unless the response type isgoogle.protobuf.Empty.Also, the documentation in the proto files has been updated to be more consistent with each other.