Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix parameter names when using JSON names. #879

Merged
merged 3 commits into from
Feb 28, 2019
Merged

Fix parameter names when using JSON names. #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bdb5b3e
Fix parameter names when using JSON names.
brocaar Feb 28, 2019
413f6e2
Add test. Fix fallback when `json_name` is unset (query params).
brocaar Feb 28, 2019
a437376
Remove fallback.
brocaar Feb 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion protoc-gen-swagger/genswagger/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ func queryParams(message *descriptor.Message, field *descriptor.Field, prefix st
}

param := swaggerParameterObject{
Name: prefix + field.GetName(),
Description: desc,
In: "query",
Default: schema.Default,
Expand All @@ -142,6 +141,12 @@ func queryParams(message *descriptor.Message, field *descriptor.Field, prefix st
Required: required,
}

if reg.GetUseJSONNamesForFields() {
param.Name = prefix + field.GetJsonName()
} else {
param.Name = prefix + field.GetName()
}

if isEnum {
enum, err := reg.LookupEnum("", fieldType)
if err != nil {
Expand Down
74 changes: 74 additions & 0 deletions protoc-gen-swagger/genswagger/template_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,80 @@ func TestMessageToQueryParameters(t *testing.T) {
}
}

func TestMessageToQueryParametersWithJsonName(t *testing.T) {
type test struct {
MsgDescs []*protodescriptor.DescriptorProto
Message string
Params []swaggerParameterObject
}

tests := []test{
{
MsgDescs: []*protodescriptor.DescriptorProto{
&protodescriptor.DescriptorProto{
Name: proto.String("ExampleMessage"),
Field: []*protodescriptor.FieldDescriptorProto{
{
Name: proto.String("test_field_a"),
Type: protodescriptor.FieldDescriptorProto_TYPE_STRING.Enum(),
Number: proto.Int32(1),
JsonName: proto.String("testFieldA"),
},
},
},
},
Message: "ExampleMessage",
Params: []swaggerParameterObject{
swaggerParameterObject{
Name: "testFieldA",
In: "query",
Required: false,
Type: "string",
},
},
},
}

for _, test := range tests {
reg := descriptor.NewRegistry()
reg.SetUseJSONNamesForFields(true)
msgs := []*descriptor.Message{}
for _, msgdesc := range test.MsgDescs {
msgs = append(msgs, &descriptor.Message{DescriptorProto: msgdesc})
}
file := descriptor.File{
FileDescriptorProto: &protodescriptor.FileDescriptorProto{
SourceCodeInfo: &protodescriptor.SourceCodeInfo{},
Name: proto.String("example.proto"),
Package: proto.String("example"),
Dependency: []string{},
MessageType: test.MsgDescs,
Service: []*protodescriptor.ServiceDescriptorProto{},
},
GoPkg: descriptor.GoPackage{
Path: "example.com/path/to/example/example.pb",
Name: "example_pb",
},
Messages: msgs,
}
reg.Load(&plugin.CodeGeneratorRequest{
ProtoFile: []*protodescriptor.FileDescriptorProto{file.FileDescriptorProto},
})

message, err := reg.LookupMsg("", ".example."+test.Message)
if err != nil {
t.Fatalf("failed to lookup message: %s", err)
}
params, err := messageToQueryParameters(message, reg, []descriptor.Parameter{})
if err != nil {
t.Fatalf("failed to convert message to query parameters: %s", err)
}
if !reflect.DeepEqual(params, test.Params) {
t.Errorf("expected %v, got %v", test.Params, params)
}
}
}

func TestApplyTemplateSimple(t *testing.T) {
msgdesc := &protodescriptor.DescriptorProto{
Name: proto.String("ExampleMessage"),
Expand Down