grpc-ecosystem/grpc-gateway

Support using FieldMasks with GET requests

Open

#698 opened on Jul 10, 2018

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
enhancementhelp wanted

Description

Some GET requests (e. g. search) benefit greatly from being able to distinguish between default (e. g. 0) and non-defined values, since searching by "name='John' && age = 0" is not the same as "name='John' && age = undefined". Since FieldMasks are a generally recommended approach for optional fields in gRPC, it would be super helpful if grpc-gateway would support that.

Contributor guide

Tech stack
go
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GogRPCprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate how FieldMasks are currently handled in the gateway's marshaling/unmarshaling. Look at the generated code for GET endpoints to understand how query parameters are parsed. Consider adding support for field masks in the HTTP request query parameters for GET requests. Review comments on the issue for any prior discussions or design suggestions.