grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Ouverte

#2 833 ouverte le 3 août 2022

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

Métriques du dépôt

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

Description

As part of #2825, @oyvindwe mentioned that the HTTPRule parser may allow templates that will cause the OpenAPIv2 generator to generate invalid paths. Specifically:

Does the HttpRule parser also allow other path templates outside the specification? Specifically : before a variable? The reason I am asking is that the the joining of the path in the generator assumes that only the last part can start with :.

We should investigate whether this is the case, and if so, probably patch the openapiv2 generator to remove this assumption, as introducing errors for these templates now is a backwards incompatible change.

Related to #2824.

Guide contributeur

Direction de recherche
Inspectez l'analyseur HTTPRule pour voir s'il autorise des modèles invalides (comme les deux points avant des variables) et vérifiez la logique de jonction de chemin du générateur OpenAPIv2 pour voir si elle suppose que seule la dernière partie peut commencer par deux points. Si l'analyseur autorise des modèles invalides, envisagez de corriger le générateur pour les gérer correctement.
Stack technique
go
Domaine
backend
Type d'issue
Recherche
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
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40