grpc-ecosystem/grpc-gateway

protoc-gen-swagger: support maps in query parameters

Open

#984 opened on 2019年8月6日

GitHub で見る
 (10 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
bughelp wantedopenapi

説明

Hi guys, having following definition:

message Test {
    map<string, string> filters = 1;
}

service TestService {
    rpc TestRpc(Test) returns (Test) {
        option (google.api.http) = {
            get: "/test"
        };
    }
}

Which goes through swagger generator and ends up without the map being mentioend as parameters in request:

"/test": {
      "get": {
        "operationId": "TestRpc",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/offersTest"
            }
          }
        },
        "tags": [
          "TestService"
        ]
      }
    }

I thought that I can add map params to the query... but I dont think so now and I cant tell if it's a bug... KR Jirka

コントリビューターガイド

技術スタック
go
領域
api
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
protobufgRPCGoSwagger generation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
20
調査方針
The issue requests support for map fields in query parameters in the protoc gen swagger generator. Currently, the generator omits map fields from the Swagger specification. Investigation should focus on the code that translates protobuf message fields into Swagger parameters, likely in the protoc gen swagger plugin. Look for how nested fields are handled and extend that logic to support map types. Also, review any existing comments or linked PRs for prior discussion or attempted solutions.
protoc-gen-swagger: support maps in query parameters · grpc-ecosystem/grpc-gateway#984 | Good First Issue