変更履歴

この変更履歴には、API 設計ガイドに対する注意すべき変更点が明記されています。

2024-10

  • ディレクトリ構造と命名規則を除く、設計ページを Google AIP にリダイレクトしました。

2021-12

  • https://google.aip.dev/9 との整合性を保つため、用語を Networked API から Network API に変更しました。

2021-09

  • Google API のエラー形式 v1 と v2 の両方を記載。

2021-04

  • 公開設定ベースのバージョニングが導入されました。

  • 用語集に API タイトルを加えました。

2021-03

  • 出力専用フィールドのアノテーションを追加しました。

  • 明示的な _UNSPECIFIED 値を常に含めるように、列挙値のガイダンスを更新します。

  • リソース名の生成および解析に関するガイダンスを追加しました。

  • 標準フィールドに progress_percent を追加しました。

2021-02

  • proto3 optional プリミティブ フィールドに関するガイダンスを追加しました。

2021-01

  • エラーページを更新して、google.rpc.ErrorInfo と google.api.ErrorReason に関連する最新の改善を含めました。

  • oauth2l、curl、システム パラメータを使って Google API のエラーをトラブルシューティングする方法のガイドを追加しました。

  • エラーページに、502 エラーコードの説明を追加しました。これは、API のエラーではなく、ネットワークのエラーです。

2020-12

  • パッケージ名には、グローバルな整合性を確保するため、他で使われていないコンポーネント名を使用する必要があります。パッケージ名にアンダースコアは使用できません。

2020-09

  • 一部のフィールド記述要件をクリーンアップしました。RFC 2119 に準拠せずに「must」（必須）を使用している部分を RFC 2119 に準拠した「should」（要請）命令型に変更しました。

  • （すでに一覧表示されている）google.protobuf.Timestamp delete_time のために bool deleted 標準フィールドを削除しました。

2020-07

  • https://google.aip.dev/192#formatting と一致するように documentation.md を更新しました。Markdown テーブルと未加工の HTML を proto コメントで使用することはできません。

  • エラー処理に ErrorInfo を追加しました。

  • 設計パターンに大きなペイロードを追加しました。

2020-04

  • 用語集で Google Cloud API の名前を Cloud API に変更しました。
  • API サービスの類義語として API とサービスを取り入れました。

2020-02

  • 2 つのバージョニング戦略（チャネルベースとリリースベース）を追加して、ポイント バージョンに関するガイダンスを削除し、セマンティック バージョニングの参照方法を変更しました。

2020-01

  • データ保持を設計パターンに追加しました。

2019-11

  • 用語 Cloud API を用語集に追加しました。
  • UNAVAILABLE エラーの場合にのみ、クライアントに再試行をおすすめする内容を追加しました。

2019-06

  • 設計パターンに「ブール型、列挙型、文字列型」を追加しました。

2019-03

  • 標準フィールドにシステム パラメータを追加しました。

2019-02

  • ドメインをスコープとする名前を設計パターンに追加しました。

2018-03

  • 設計パターンにストリーミング ハーフクローズ セマンティクスを追加しました。

2018-02

  • 標準フィールドに read_time を追加しました。

2018-01

  • API サービス定義のスキーマ リファレンスを追加しました。

2017-12

  • API メジャー バージョンはプロト パッケージ名の最新コンポーネントである必要があることを明確にしました。

2017-11

  • Create メソッドが入力リソースを取得する理由を明確にしました。
  • evidence や weather など、複数形を持たないコレクション ID を明確にしました。
  • 設計パターンにシングルトン リソースを追加しました。
  • 頭字語とバージョンの C# 命名規則を明確にしました。

2017-09

  • 標準フィールドに mime_type を追加しました。
  • 標準フィールドに expire_time を追加しました。
  • 標準フィールドに start_time と end_time を追加しました。

2017-02

  • 用語集に「API エンドポイント」を追加しました。
  • 標準フィールドに update_mask を追加しました。
  • 標準メソッドに FieldMask へのリンクを追加しました。
  • OpenAPI 仕様では符号なしの整数がサポートされないことを記載しました。
  • メソッド名では命令法で動詞を使用することを明確にしました。
前へ
ディレクトリ構造