-
Notifications
You must be signed in to change notification settings - Fork 365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: do not return repeated directly #1605
base: master
Are you sure you want to change the base?
Conversation
Use the complete response when the response is a list Signed-off-by: Santiago Jimenez Giraldo <[email protected]>
The latest Buf updates on your PR. Results from workflow Buf CI / push-module (pull_request).
|
Generally I agree with this. See https://google.aip.dev/132. |
get: "/v1alpha2/topics/{topic_name}/configurations" | ||
response_body: "configurations" | ||
}; | ||
option (google.api.http) = {get: "/v1alpha2/topics/{topic_name}/configurations"}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we do it, despite knowing the number of entries is very limited and will never exceed an unreasonable number that couldn't be retrieved in one go? The AIP-132 seems to suggest that. I guess we'll follow then
@@ -292,10 +292,7 @@ service TopicService { | |||
}; | |||
} | |||
rpc GetTopicConfigurations(GetTopicConfigurationsRequest) returns (GetTopicConfigurationsResponse) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good observation. Maybe ListTopicConfigurations()
is a better choice. Agree it kinda depends on how you look at it. But I do not feel strongly about it.
Use the complete response when the response is a list.
for some method the example does not match the actual response and we probably want to ensure the response is not nested. maybe the question is around breaking the API, so happy to do it for V1