grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Offen

#2.833 geöffnet am 03.08.2022

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

Repository-Metriken

Stars
 (16.971 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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
Überprüfen Sie den HTTPRule Parser, ob er ungültige Vorlagen (z. B. Doppelpunkte vor Variablen) zulässt, und prüfen Sie die Pfadverbindungslogik des OpenAPIv2 Generators, ob sie annimmt, dass nur der letzte Teil mit einem Doppelpunkt beginnen kann. Falls der Parser ungültige Vorlagen zulässt, sollten Sie den Generator patchen, um diese ordnungsgemäß zu handhaben.
Tech Stack
go
Domain
backend
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40