tommwq.work/aip

AIP-205 Beta版本发布前置条件

· [tommwq@126.com]
编号 205
原文链接 https://google.aip.dev/205
状态 批准
创建日期 2019-02-18
更新日期 2019-02-18

API通常会发布Alpha版本,获取客户的早期反馈。这时API是临时的,可能经过多次修改,直到收集到重要反馈之后,API才进入稳定的Beta版本。

既然Alpha版本的目的是收集反馈,API不需要很完美,也不会严格要求API作者解决每个可用性问题或API标准中的每一点。通常,API作者和审查者无法对最佳设计达成一致,而找出答案的最好方法是让用户试用。

然而一旦收集到反馈,API即将升级到Beta版本,可用性问题和风格问题必须解决。为了确保这些问题不被遗漏,应在API中明确记录这些问题。

指南

如果API存在可用性问题或违反API标准,设计在进入Beta版本之前应接受额外审查, 必须 使用protobuf注释链接到本文档,以确保在API发布Beta版本之前修正设计。

注释还 必须 指出应当在Beta版做出何种更改。例如:

message InputConfig {
  // 输入参数。
  // (-- aip.dev/beta-blocker: 在Beta发布之前将已知参数转换为显式字段。 --)
  map<string, string> parameters = 1;
}

如果确实需要违反API标准的例外情况延续到Beta版本和发行版本,请参见AIP-200。