fix!: use resource field in http body for Updates #1198
Conversation
fix: support parsing well known types in query params
| @@ -58,7 +58,7 @@ service Identity { | |||
| rpc UpdateUser(UpdateUserRequest) returns (User) { | |||
| option (google.api.http) = { | |||
| patch: "/v1beta1/{user.name=users/*}" | |||
| body: "*" | |||
| body: "user" | |||
There was a problem hiding this comment.
Why not have * so that the user can specify which fields to PATCH? It seems like this is one of the prime uses cases for field masks.
There was a problem hiding this comment.
I'm not sure what you mean. The update_mask will end up in the query params. We don't lose any functionality here, just fixing a non-compliant binding (https://google.aip.dev/134) so that we can test a real use case.
There was a problem hiding this comment.
Ah, gotcha. "There must be a body key in the google.api.http annotation, and it must map to the resource field in the request message. All remaining fields should map to URI query parameters."
OK, my bad. LGTM!
| @@ -58,7 +58,7 @@ service Identity { | |||
| rpc UpdateUser(UpdateUserRequest) returns (User) { | |||
| option (google.api.http) = { | |||
| patch: "/v1beta1/{user.name=users/*}" | |||
| body: "*" | |||
| body: "user" | |||
There was a problem hiding this comment.
Ah, gotcha. "There must be a body key in the google.api.http annotation, and it must map to the resource field in the request message. All remaining fields should map to URI query parameters."
OK, my bad. LGTM!
|
Ok so I am going to remove the Breaking Change indicator from the commit because I don't want to release this as a major version (at some point we really should make a v1 though). |
Fixes the
google.api.httpbodyfields for UpdateUser, UpdateBlurb, and UpdateRoom to use the field in the request representing the resource, instead of*.This also adds support for parsing some of the well known protobuf types that may be present as JSON encoded query parameters and that have special JSON encoding formats (see https://developers.google.com/protocol-buffers/docs/proto3#json). This API only makes use of Timestamp, Duration, and FieldMask.