grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Open

#2833 aperta il 3 ago 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Go (2250 fork)batch import
bughelp wantedquestion

Metriche repository

Star
 (16.971 star)
Metriche merge PR
 (Merge medio 1g 4h) (141 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga l'implementazione del parser HTTPRule in protoc gen grpc gateway per verificare se consente template con ':' prima dei nomi delle variabili. Il codice rilevante si trova nel parser e nel generatore OpenAPIv2. L'obiettivo è determinare se il generatore presuppone che solo l'ultima parte possa iniziare con ':', e in tal caso, rimuovere tale presupposto. Rivedi i problemi correlati #2825 e #2824 per il contesto.
Tech stack
gogrpc
Dominio
backendapitooling
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go programminggRPC basicsHTTPRule specification
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30