Skip to content
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

[AIP-157] The value of the field mask parameter #1330

Open
szk2s opened this issue Mar 22, 2024 · 0 comments
Open

[AIP-157] The value of the field mask parameter #1330

szk2s opened this issue Mar 22, 2024 · 0 comments

Comments

@szk2s
Copy link

szk2s commented Mar 22, 2024

In AIP-157, it is stated:

The value of the field mask parameter must be a google.protobuf.FieldMask.

This wording might suggest that the value should be in the proto3 JSON representation of a google.protobuf.FieldMask, which I suspect not be the intended interpretation. Given that examples in the AIP include using this parameter as an HTTP query parameter, an HTTP header, and a gRPC metadata entry, it appears that the more prevalent practice is a comma-separated list of paths for specifying field masks.

-H X-Goog-FieldMask: routes.distanceMeters,routes.duration

If my understanding is indeed correct, it might be clearer to revise the statement in AIP-157 to reflect this common usage, potentially rewording it as:

The value of the field mask parameter must be a comma-separated list of paths.

Thank you for considering this adjustment for clarity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant