grpc-ecosystem/grpc-gateway

Support nested messages in GET request queries

Open

#492 opened on Dec 1, 2017

View on GitHub
 (12 comments) (10 reactions) (0 assignees)Go (2,250 forks)batch import
enhancementhelp wanted

Repository metrics

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

Description

Given the

service MyService {
    rpc myMethod (myMethodRequest) returns (myMethodResponse) {
        option (google.api.http) = {
            get: "/method/all"
        };
    }
}

message myMethodRequest {
    repeated Scoped scope = 1;

    message Scoped {
        oneof condition {
            ById by_id = 1;
        }
        message ById {
            uint32 id = 1;
        }
    }
}

message myMethodResponse {
    repeated uint32 ids = 1;
}

with GET request

localhost:8080/method/all?scope.by_id.id=3

returns an error

unexpected repeated field in scope.by_id.id

Contributor guide

Research direction
Examine how the gateway handles repeated nested fields in query parameters for GET requests. The error suggests the implementation incorrectly treats nested fields as repeated. Check the runtime pattern matching logic for query parameter parsing, particularly the handling of oneof and nested messages. Look at the existing test cases for nested messages to understand expected behavior.
Tech stack
go
Domain
apibackend
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.
Half day
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
Goprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60