envoyproxy/envoy

Use validate tags to auto generate markup

开放

#3,092 创建于 2018年4月16日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)C++ (5,373 个派生)batch import
api/v3area/docshelp wantedpriority/high

仓库指标

星标
 (27,997 个星标)
PR 合并指标
 (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