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 (2,250 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

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

Research direction
Investigate how FieldMasks are currently handled in the grpc gateway for other HTTP methods (e.g., PATCH) and implement the same parsing and application logic for GET requests. Look at the existing fieldmask handling code in the runtime package and see how to apply fieldmasks to query parameters.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GogRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60