grpc-ecosystem/grpc-gateway

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

Open

#3 696 ouverte le 26 oct. 2023

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Go (2 250 forks)batch import
bughelp wantedopenapi

Métriques du dépôt

Stars
 (16 971 stars)
Métriques de merge PR
 (Merge moyen 1j 4h) (141 PRs mergées en 30 j)

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
Examinez le fichier template.go dans le répertoire protoc gen openapiv2 pour localiser où collectionFormat est codé en dur à 'multi'. Passez en revue la gestion de l'option repeated path param separator pour garantir une propagation correcte. Vérifiez les tests existants pour la génération des paramètres de chemin et assurez vous que la correction produit une spécification OpenAPI correcte.
Stack technique
go
Domaine
api
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.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go programmingprotoc gen openapiv2 template understanding
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75