grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Open

#2 833 ouverte le 3 août 2022

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

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

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
Examinez l'implémentation de l'analyseur HTTPRule dans protoc gen grpc gateway pour vérifier s'il autorise les modèles avec ':' avant les noms de variables. Le code pertinent se trouve dans l'analyseur et le générateur OpenAPIv2. L'objectif est de déterminer si le générateur suppose que seule la dernière partie peut commencer par ':', et si c'est le cas, de supprimer cette hypothèse. Consultez les problèmes connexes #2825 et #2824 pour le contexte.
Stack technique
gogrpc
Domaine
backendapitooling
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.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go programminggRPC basicsHTTPRule specification
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30