grpc-ecosystem/grpc-gateway

Support mapping request body to map type

Open

#765 opened on Oct 2, 2018

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
enhancementhelp wantedwaiting on reporter

Repository metrics

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

Description

Is there a way tomap the message body to a keyed map? I.e. with a proto definition containing:

    rpc UpdateConfig (ServiceConfig) returns (OpResult) {
        option (google.api.http) = {
			post: "/v1/robotctl/services/configure"
			body: "config"
		};
    }

message ServiceConfig {
    ServicesReq services            = 1;
    map<string, string> config                   = 2;
}

The idea being that the body of the received message would map to a key in the, eg map<config, body_of_message>

Currently on compiling for grpc-gateway, the following error is thrown - which is odd given that there is no repeated element:

--grpc-gateway_out: repeated field not allowed in field path: config in config

Contributor guide

Research direction
Examine the grpc gateway source code to understand why map fields are rejected in field paths and check if there is a workaround or pending fix.
Tech stack
go
Domain
backendapi
Issue type
Bug
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-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
GoprotobufgRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65