grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Aperta

#2833 aperta il 3 ago 2022

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)Go (2250 fork)batch import
bughelp wantedquestion

Metriche repository

Star
 (16.971 stelle)
Metriche merge PR
 (Merge medio 8g 23h) (147 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
Ispeziona il parser HTTPRule per vedere se consente template non validi (come i due punti prima delle variabili) e controlla la logica di unione dei percorsi del generatore OpenAPIv2 per vedere se assume che solo l'ultima parte possa iniziare con due punti. Se il parser consente template non validi, considera di modificare il generatore per gestirli in modo appropriato.
Tech stack
go
Dominio
backend
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40