grpc-ecosystem/grpc-gateway

Investigate whether HTTPRule parser allows invalid templates

Open

#2,833 opened on 2022年8月3日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
bughelp wantedquestion

説明

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.

コントリビューターガイド

技術スタック
gogrpc
領域
backendapitooling
Issue 種別
research
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programminggRPC basicsHTTPRule specification
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
30
調査方針
Investigate the HTTPRule parser implementation in protoc gen grpc gateway to check if it allows templates with ':' before variable names. The relevant code is in the parser and the OpenAPIv2 generator. The goal is to determine if the generator assumes only the last part can start with ':', and if so, remove that assumption. Review related issues #2825 and #2824 for context.