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.