grpc-ecosystem/grpc-gateway

Inconsistent enum behaviour

Open

#354 opened on Apr 13, 2017

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Go (2,250 forks)batch import
help wanted

Repository metrics

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

Description

Given the following messages and enumeration:

message NameCheckResponse {
    Result result = 1;
}

message MultiNameCheckResponse {
    map<string, Result> results = 1;
}

enum Result {
    AVAILABLE = 0;
    UNAVAILABLE = 1;
    UNKOWN = 2;
}

The returned value in case of the first message is the name of the enum. In the second case, it's the numeric value.

Is this behaviour intended?

Contributor guide

Research direction
Investigate how the grpc gateway marshals enum values in map fields versus regular message fields. Check the code that handles protobuf to JSON conversion for map types and look for any differences in enum serialization.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoProtocol BuffersgRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60