grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Open

#2.833 aberto em 3 de ago. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Go (2.250 forks)batch import
bughelp wantedquestion

Métricas do repositório

Stars
 (16.971 stars)
Métricas de merge de PR
 (Mesclagem média 1d 4h) (141 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue a implementação do analisador HTTPRule no protoc gen grpc gateway para verificar se ele permite modelos com ':' antes dos nomes das variáveis. O código relevante está no analisador e no gerador OpenAPIv2. O objetivo é determinar se o gerador assume que apenas a última parte pode começar com ':', e, se for o caso, remover essa suposição. Revise os problemas relacionados #2825 e #2824 para contexto.
Pilha de tecnologia
gogrpc
Domain
backendapitooling
Tipo Issue
Pesquisa
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go programminggRPC basicsHTTPRule specification
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30