grpc-ecosystem/grpc-gateway

protoc-gen-swagger: support maps in query parameters

Open

#984 opened on Aug 6, 2019

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
bughelp wantedopenapi

Repository metrics

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

Description

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

Contributor guide

Research direction
Examine the protoc gen swagger plugin code to see how query parameters are generated for map fields. Look for any existing handling of repeated or map types in query parameters and consider how to extend it to support maps.
Tech stack
gogrpc
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.
Clear
Prerequisites
GoProtocol Buffers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60