Log Perubahan

Log perubahan ini menyoroti perubahan penting pada Panduan Desain API.

2021-12

  • Mengubah terminologi Networked API menjadi Network API agar konsisten dengan https://google.aip.dev/9.

2021-09

  • Dokumentasikan format error Google API v1 dan v2.

2021-04

  • Memperkenalkan pembuatan versi berbasis visibilitas.

  • Memperkenalkan judul API pada glosarium.

2021-03

  • Menambahkan anotasi untuk kolom yang hanya menampilkan output.

  • Perbarui panduan nilai enum agar selalu menyertakan nilai _UNSPECIFIED eksplisit.

  • Tambahkan panduan tentang cara membuat dan mengurai nama resource.

  • Menambahkan progress_percent ke kolom standar.

2021-02

  • Menambahkan panduan tentang kolom primitif optional proto3.

2021-01

  • Memperbarui halaman Error untuk mencakup peningkatan terbaru yang terkait dengan google.rpc.ErrorInfo dan google.api.ErrorReason.

  • Menambahkan panduan tentang cara menggunakan oauth2l, curl, dan Parameter Sistem untuk memecahkan masalah error dengan Google API.

  • Menambahkan penjelasan kode error 502 ke halaman Error. Ini adalah error jaringan, bukan error API.

2020-12

  • Nama paket harus menggunakan nama komponen tunggal untuk konsistensi global. Nama paket tidak boleh menggunakan garis bawah.

2020-09

  • Membersihkan beberapa persyaratan deskripsi kolom; mengubah beberapa penggunaan kata "harus" di luar RFC 2119 menjadi perintah "harus" RFC 2119.

  • Menghapus kolom standar bool deleted, dan menggantinya dengan google.protobuf.Timestamp delete_time (yang sudah tercantum).

2020-07

  • Mengupdate documentation.md agar sesuai dengan https://google.aip.dev/192#formatting. Tabel Markdown dan HTML mentah tidak boleh digunakan dalam komentar proto.

  • Menambahkan ErrorInfo untuk penanganan error.

  • Menambahkan Payload Besar untuk pola desain.

2020-04

  • Mengganti nama Cloud API menjadi Google Cloud API di glosarium.
  • Memperkenalkan API dan layanan sebagai sinonim dari layanan API.

2020-02

  • Mengupdate pembuatan versi untuk menambahkan dua strategi pembuatan versi (berbasis channel dan berbasis rilis), menghapus panduan tentang versi titik, dan mengubah cara kita merujuk pada pembuatan versi semantik.

2020-01

  • Menambahkan retensi data ke pola desain.

2019-11

  • Menambahkan terminologi Cloud API ke glosarium.
  • Sarankan klien untuk mencoba lagi hanya untuk error TIDAK TERSEDIA.

2019-06

  • Tambahkan "Bool vs Enum vs String" untuk mendesain pola.

2019-03

  • Menambahkan parameter sistem ke kolom standar.

2019-02

  • Menambahkan nama yang memiliki cakupan domain untuk mendesain pola.

2018-03

  • Menambahkan semantik setengah dekat streaming ke pola desain.

2018-02

  • Tambahkan read_time ke Kolom Standar.

2018-01

  • Menambahkan referensi skema untuk Definisi Layanan API.

2017-12

  • Versi utama Clarify API harus menjadi komponen terakhir dari nama paket proto.

2017-11

  • Jelaskan alasan metode Create mengambil resource input.
  • Mengklarifikasi ID koleksi yang tidak berbentuk jamak, seperti bukti dan cuaca.
  • Menambahkan resource singleton ke pola desain.
  • Memperjelas konvensi penamaan C# untuk akronim dan versi.

2017-09

  • Menambahkan mime_type ke kolom standar.
  • Menambahkan expire_time ke kolom standar.
  • Menambahkan start_time dan end_time ke kolom standar.

2017-02

  • Tambahkan "endpoint API" ke glosarium.
  • Menambahkan update_mask ke kolom standar.
  • Tambahkan link ke FieldMask ke metode standar.
  • Sebutkan bahwa spesifikasi OpenAPI tidak mendukung bilangan bulat yang tidak ditandatangani.
  • Klarifikasi bahwa nama metode harus menggunakan kata kerja dalam mood imperatif.