Log perubahan

Log perubahan ini menyoroti perubahan historis penting pada Panduan Desain API, seperti revisi pada konvensi penamaan, penanganan error, dan kolom standar. Selain itu, alat ini mencatat migrasi dokumentasi ke Google API Improvement Proposals (AIP).

2025-06

  • Mengalihkan Konvensi Penamaan halaman Desain ke Google AIP.

2024-10

  • Mengalihkan halaman Desain ke AIP Google, kecuali untuk Struktur Direktori dan Konvensi Penamaan.

2021-12

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

2021-09

  • Mendokumentasikan format error Google API v1 dan v2.

2021-04

  • Memperkenalkan pembuatan versi berbasis visibilitas.

  • Memperkenalkan judul API ke glosarium.

2021-03

  • Menambahkan anotasi untuk kolom hanya output.

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

  • Menambahkan panduan tentang cara membuat dan mengurai nama resource.

  • Tambahkan progress_percent ke kolom standar.

2021-02

  • Menambahkan panduan tentang kolom primitif optional proto3.

2021-01

  • Memperbarui halaman Error untuk mencakup peningkatan terbaru terkait 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. 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 "harus" di luar RFC 2119 menjadi arahan "sebaiknya" RFC 2119.

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

2020-07

  • Memperbarui 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 dalam glosarium.
  • Memperkenalkan API dan layanan sebagai sinonim layanan API.

2020-02

  • Memperbarui pembuatan versi untuk menambahkan dua strategi pembuatan versi (berbasis channel dan berbasis rilis), menghapus panduan tentang versi titik, dan mengubah cara kami merujuk ke pembuatan versi semantik.

2020-01

  • Menambahkan retensi data ke pola desain.

2019-11

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

2019-06

  • Tambahkan "Bool vs Enum vs String" ke pola desain.

2019-03

  • Tambahkan parameter sistem ke kolom standar.

2019-02

  • Menambahkan nama cakupan domain ke pola desain.

2018-03

  • Menambahkan semantik setengah tutup streaming ke pola desain.

2018-02

  • Tambahkan read_time ke Kolom Standar.

2018-01

  • Menambahkan referensi skema untuk Definisi Layanan API.

2017-12

  • Memperjelas bahwa versi utama API harus menjadi komponen terakhir dari nama paket proto.

2017-11

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

2017-09

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

2017-02

  • Tambahkan "endpoint API" ke glosarium.
  • Tambahkan update_mask ke kolom standar.
  • Menambahkan link ke FieldMask ke metode standar.
  • Menyebutkan bahwa spesifikasi OpenAPI tidak mendukung bilangan bulat tidak bertanda.
  • Memperjelas bahwa nama metode harus menggunakan kata kerja dalam mood imperatif.
Sebelumnya
Struktur direktori