grpc-ecosystem/grpc-gateway

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

Open

#3,696 建立於 2023年10月26日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Go (16,971 star) (2,250 fork)batch import
bughelp wantedopenapi

描述

🐛 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".

貢獻者指南

技術棧
go
領域
api
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go programmingprotoc gen openapiv2 template understanding
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
Examine the file template.go in the protoc gen openapiv2 directory to locate where collectionFormat is hardcoded to 'multi'. Review the repeated path param separator option handling to ensure proper propagation. Check any existing tests for path parameter generation and verify the fix produces correct OpenAPI spec.