grpc-ecosystem/grpc-gateway

[protoc-gen-openapiv2] Incorrectly generated OpenAPIv2 spec when using repeated_path_param_separator option

Open

#3,696 opened on Oct 26, 2023

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

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (PR metrics pending)

Description

🐛 Bug Report

When I use repeated_path_param_separator option with any value I get result in my documentation where "collectionFormat": "multi". I found what in template.go you force set 'multi' to "collectionFormat".

Contributor guide

Research direction
Inspect the template.go file in the protoc gen openapiv2 directory, locate where collectionFormat is hardcoded as 'multi', and understand how the repeated path param separator option should affect the output. Check the option's handling in the generator logic.
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.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Goprotoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60