Skip to content

proposed fix: Merging operations causes duplicate key/value pairs in "map" fields #460

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

proposed fix: Merging operations causes duplicate key/value pairs in "map" fields #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fe853f
Update test expectations for overriding responses with operation anno…
sloretz Sep 26, 2025
f8157ef
Output diff when test fails
sloretz Sep 26, 2025
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
31 changes: 31 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,37 @@ service Messaging1 {
]
};
}

rpc StreamMessages(Message) returns(stream Message) {
option(google.api.http) = {
get: "/v1/stream/{message_id}"
body: "*"
};
option (openapi.v3.operation) = {
responses: {
response_or_reference: {
name: "200"
value: {
response : {
description: "OK"
content: {
additional_properties: {
name: "text/event-stream"
value: {
schema: {
reference: {
_ref: "Message"
}
}
}
}
}
}
}
}
}
};
}
}

service Messaging2 {
Expand Down
30 changes: 30 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@ paths:
$ref: '#/components/schemas/Status'
security:
- BasicAuth: []
/v1/stream/{message_id}:
get:
tags:
- Messaging1
operationId: Messaging1_StreamMessages
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
"200":
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/Message'
components:
schemas:
GoogleProtobufAny:
Expand Down
30 changes: 30 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_default_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@ paths:
$ref: '#/components/schemas/Status'
security:
- BasicAuth: []
/v1/stream/{message_id}:
get:
tags:
- Messaging1
operationId: Messaging1_StreamMessages
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
"200":
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/Message'
components:
schemas:
GoogleProtobufAny:
Expand Down
30 changes: 30 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_fq_schema_naming.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@ paths:
$ref: '#/components/schemas/google.rpc.Status'
security:
- BasicAuth: []
/v1/stream/{message_id}:
get:
tags:
- Messaging1
operationId: Messaging1_StreamMessages
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/tests.openapiv3annotations.message.v1.Message'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
"200":
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/tests.openapiv3annotations.message.v1.Message'
components:
schemas:
google.protobuf.Any:
Expand Down
30 changes: 30 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_json.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@ paths:
$ref: '#/components/schemas/Status'
security:
- BasicAuth: []
/v1/stream/{message_id}:
get:
tags:
- Messaging1
operationId: Messaging1_StreamMessages
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
"200":
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/Message'
components:
schemas:
GoogleProtobufAny:
Expand Down
30 changes: 30 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_string_enum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@ paths:
$ref: '#/components/schemas/Status'
security:
- BasicAuth: []
/v1/stream/{message_id}:
get:
tags:
- Messaging1
operationId: Messaging1_StreamMessages
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
"200":
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/Message'
components:
schemas:
GoogleProtobufAny:
Expand Down
20 changes: 10 additions & 10 deletions cmd/protoc-gen-openapi/plugin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ func TestOpenAPIProtobufNaming(t *testing.T) {
}
} else {
// Verify that the generated spec matches our expected version.
err = exec.Command("diff", TEMP_FILE, fixture).Run()
output, err := exec.Command("diff", TEMP_FILE, fixture).CombinedOutput()
if err != nil {
t.Fatalf("Diff failed: %+v", err)
t.Fatalf("Diff failed: %s", output)
}
}
// if the test succeeded, clean up
Expand Down Expand Up @@ -163,9 +163,9 @@ func TestOpenAPIFQSchemaNaming(t *testing.T) {
}
} else {
// Verify that the generated spec matches our expected version.
err = exec.Command("diff", TEMP_FILE, fixture).Run()
output, err := exec.Command("diff", TEMP_FILE, fixture).CombinedOutput()
if err != nil {
t.Fatalf("Diff failed: %+v", err)
t.Fatalf("Diff failed: %s", output)
}
// Verify that the generated spec matches the source_relative version
sourceRelativeFile := strings.TrimSuffix(tt.protofile, filepath.Ext(tt.protofile)) + ".openapi.yaml"
Expand Down Expand Up @@ -207,9 +207,9 @@ func TestOpenAPIJSONNaming(t *testing.T) {
}
} else {
// Verify that the generated spec matches our expected version.
err = exec.Command("diff", TEMP_FILE, fixture).Run()
output, err := exec.Command("diff", TEMP_FILE, fixture).CombinedOutput()
if err != nil {
t.Fatalf("Diff failed: %+v", err)
t.Fatalf("Diff failed: %s", output)
}
}
// if the test succeeded, clean up
Expand Down Expand Up @@ -244,9 +244,9 @@ func TestOpenAPIStringEnums(t *testing.T) {
}
} else {
// Verify that the generated spec matches our expected version.
err = exec.Command("diff", TEMP_FILE, fixture).Run()
output, err := exec.Command("diff", TEMP_FILE, fixture).CombinedOutput()
if err != nil {
t.Fatalf("diff failed: %+v", err)
t.Fatalf("diff failed: %s", output)
}
}
// if the test succeeded, clean up
Expand Down Expand Up @@ -281,9 +281,9 @@ func TestOpenAPIDefaultResponse(t *testing.T) {
}
} else {
// Verify that the generated spec matches our expected version.
err = exec.Command("diff", TEMP_FILE, fixture).Run()
output, err := exec.Command("diff", TEMP_FILE, fixture).CombinedOutput()
if err != nil {
t.Fatalf("diff failed: %+v", err)
t.Fatalf("diff failed: %s", output)
}
}
// if the test succeeded, clean up
Expand Down