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 (16,971 stars) (2,250 forks)batch import
documentationenhancementhelp wanted

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

Tech stack
gogrpcrest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 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.
mostly clear
Prerequisites
Understanding of gRPCProtobuf basicsHTTP REST semantics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate how the grpc gateway currently handles PUT requests and partial updates. Look at the generated proxy code and consider options like using field masks or requiring full object. Review comments in issue #379 for proposed solutions and constraints. The goal is to define a clear design that allows clients to send only fields to update without resetting defaults.