更新日志

此更新日志重点介绍 API 设计指南的重大修改。

2021-12

  • 将术语联网 API 更改为网络 API,以与 https://google.aip.dev/9 保持一致。

2021-09

  • 记录 Google API 错误格式 v1 和 v2。

2021-04

  • 引入了基于公开范围的版本控制。

  • 在术语表中引入了 API 标题。

2021-03

  • 为仅限输出的字段添加了注释。

  • 更新了枚举值指南,以始终包含明确的 _UNSPECIFIED 值。

  • 添加有关如何生成和解析资源名称的指南。

  • 向标准字段添加了 progress_percent

2021-02

  • 添加了有关 proto3 optional 原初字段的指南。

2021-01

  • 更新了“错误”页面,以涵盖与 google.rpc.ErrorInfogoogle.api.ErrorReason 相关的最新改进。

  • 添加了有关如何使用 oauth2lcurl 和系统参数来排查 Google API 错误的指导。

  • 在“错误”页面中添加了 502 错误代码说明。这是一个网络错误,而不是 API 错误。

2020-12

  • 软件包名称应使用单数组件名称以实现全局一致性。软件包名称不能使用下划线。

2020-09

  • 清理了一些字段说明要求;将在 RFC 2119 之外的一些“必须”用法更改成 RFC 2119“应该”指令。

  • 移除了 bool deleted 标准字段,取而代之的是 google.protobuf.Timestamp delete_time(已列出)。

2020-07

  • 更新了 documentation.md 以匹配 https://google.aip.dev/192#formatting。 不得在 proto 注释中使用 Markdown 表和原始 HTML。

  • 为错误处理添加了 ErrorInfo

  • 为设计模式添加了大型载荷。

2020-04

  • 在词汇表中将 Cloud API 重命名为 Google Cloud API。
  • 已将 API 和服务作为 API 服务的同义词引入。

2020-02

  • 更新了版本控制,添加了两个版本控制策略(基于发布版本和基于版本),移除了关于点版本的指南,并更改了我们对语义版本控制的引用。

2020-01

  • 向设计模式添加了数据保留。

2019-11

  • 向术语库中添加了术语 Cloud API。
  • 建议客户端仅针对“不可用”错误进行重试。

2019-06

  • 向设计模式添加了“布尔值与枚举与字符串”。

2019 年 3 月

  • 向标准字段添加了系统参数。

2019-02

  • 向设计模式添加了网域范围名称。

2018-03

  • 向设计模式添加了流式半关闭语义。

2018-02

  • 向标准字段添加了 read_time

2018-01

  • 添加了 API 服务定义的架构参考。

2017-12

  • 阐释了 API 主要版本必须是 proto 包名称的最后一个组成部分。

2017-11

  • 阐释了 Create 方法获取利用资源的原因。
  • 阐释了没有复数形式的集合 ID,例如 evidence(证据) 和 weather(天气)。
  • 向设计模式添加了单例资源。
  • 阐释了首字母缩写词和版本的 C# 命名惯例。

2017-09

  • 向标准字段添加了 mime_type
  • 向标准字段添加了 expire_time
  • 向标准字段添加了 start_timeend_time

2017-02

  • 向词汇表添加了“API 端点”
  • 向标准字段添加了 update_mask
  • 向标准方法添加了 FieldMask 链接。
  • 说明了 OpenAPI 规范不支持无符号整数。
  • 阐明方法名称应该以祈使语气使用动词。