grpc-ecosystem/grpc-gateway

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

Ouverte

#3 696 ouverte le 26 oct. 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Go (2 250 forks)batch import
bughelp wantedopenapi

Métriques du dépôt

Stars
 (16 971 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Inspectez le fichier template.go dans le repertoire protoc gen openapiv2, localisez l'endroit ou collectionFormat est code en dur comme 'multi', et comprenez comment l'option repeated path param separator devrait affecter la sortie. Verifiez le traitement de l'option dans la logique du generateur.
Stack technique
go
Domaine
apibackend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Goprotoc
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60