grpc-ecosystem/grpc-gateway

REST PUT request only passes fields to update

Open

#379 opened on May 5, 2017

View on GitHub
 (21 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
documentationenhancementhelp wanted

Repository metrics

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

Description

I'm trying to export REST APIs and the problem is that in my PUT request, client usually tries to pass only fields to update, but the generated proto will set all the other fields to its default value. I have no way to tell which fields to update.

Of course I can restrict client to always pass the full object, but is there better way to do this?

Contributor guide

Research direction
Investigate how to support partial updates in gRPC gateway, possibly by implementing field masks or supporting PATCH semantics. Look at existing discussions and proposals in the issue comments.
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.
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.
Mostly clear
Prerequisites
GogRPCHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65