Skip to content

Commit

Permalink
docs: specify invalid cases for FieldMask (grpc-ecosystem#2477)
Browse files Browse the repository at this point in the history
Specify that FieldMask is treated as a regular field in the scenario where the gateway' HTTP method is not PATCH, or if Body is `"*"`.
  • Loading branch information
hhhapz authored Dec 26, 2021
1 parent 910891b commit 2ee9ba5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/mapping/patch_feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ parent: Mapping

The HTTP PATCH method allows a resource to be partially updated.

If a binding is mapped to patch and the request message has exactly one FieldMask message in it, additional code is rendered for the gateway handler that will populate the FieldMask based on the request body.
If a binding is mapped to patch and the request message has exactly one FieldMask message in it, additional code is rendered for the gateway handler that will populate the FieldMask based on the request body. FieldMask is treated as a regular field by the gateway if the request method is not PATCH, or if the HttpRule body is `"*"`

There are two scenarios:

Expand Down

0 comments on commit 2ee9ba5

Please sign in to comment.