grpc-ecosystem/grpc-gateway

Support mapping request body to map type

Open

#765 创建于 2018年10月2日

在 GitHub 查看
 (8 评论) (0 反应) (0 负责人)Go (16,971 star) (2,250 fork)batch import
enhancementhelp wantedwaiting on reporter

描述

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

贡献者指南

技术栈
gogrpcrest api
领域
backendapitooling
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic Goprotobuf familiaritygRPC concepts
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
The issue is about a protobuf map field in a gRPC HTTP annotation causing a compilation error 'repeated field not allowed in field path'. The error is likely from the code that validates field paths in the grpc gateway generator. Look for where this error message is defined (e.g., in protoc gen grpc gateway/internal/gengateway/template.go or similar). Understand how the generator processes field paths and why map fields are incorrectly treated as repeated. Check if there are any existing PRs or comments that discuss this. The fix would involve allowing map fields in body paths or properly distinguishing them from repeated fields.