envoyproxy/envoy

Use validate tags to auto generate markup

Open

#3,092 建立於 2018年4月16日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)C++ (5,373 fork)batch import
api/v3area/docshelp wantedpriority/high

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

It would be nice to leverage protoc-gen-validate tags to autogenerate markup about field constraints.

For instance for https://github.com/envoyproxy/data-plane-api/blob/2f7459baf7c95cf7e634f848948a022c4b16fa79/api/eds.proto#L94 it would be nice to add a note that mentioned the constraint.

Migrated from https://github.com/envoyproxy/data-plane-api/issues/311

貢獻者指南

研究方向
研究如何使用 protoc gen validate 標籤自動為 Envoy 的 proto 文件中的欄位約束生成標記。查看 data plane api 倉庫中的現有文檔生成方式。
技術棧
cpp
領域
documentationbackend
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
較久未更新
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40