grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Open

#2.833 geöffnet am 3. Aug. 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (2.250 Forks)batch import
bughelp wantedquestion

Repository-Metriken

Stars
 (16.971 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 4h) (141 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche die Implementierung des HTTPRule Parsers in protoc gen grpc gateway, um zu prüfen, ob er Vorlagen mit ':' vor Variablennamen zulässt. Der relevante Code befindet sich im Parser und im OpenAPIv2 Generator. Das Ziel ist festzustellen, ob der Generator annimmt, dass nur der letzte Teil mit ':' beginnen kann, und falls ja, diese Annahme zu entfernen. Siehe die verwandten Issues #2825 und #2824 für den Kontext.
Tech Stack
gogrpc
Domain
backendapitooling
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go programminggRPC basicsHTTPRule specification
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30