Versi
Apa yang bisa berubah di dalam /v1, dan apa yang tidak.
Versi API ada di path: /api/v1. Di dalam v1, perubahan bersifat menambah dan diumumkan di
catatan perubahan.
Bisa berubah tanpa pemberitahuan
Section titled “Bisa berubah tanpa pemberitahuan”- Endpoint baru, field request opsional baru, dan parameter query baru.
- Field baru di respons. Abaikan field yang tidak Anda kenal.
- Nilai baru di daftar terbuka: platform, content type, pesan error, jenis event notifikasi dan webhook, kode masalah pre-flight. Tangani nilai yang tidak dikenal dengan wajar.
- Kata-kata
messagedi error. Cocokkan dengancode, bukan pesannya. - Batas platform di
GET /content-types, saat platform mengubah aturannya.
Tidak akan berubah di dalam v1
Section titled “Tidak akan berubah di dalam v1”- Menghapus atau mengganti nama endpoint, field atau nilai
code. - Mengubah tipe atau arti sebuah field.
- Menjadikan field request opsional sebagai wajib.
Kalau ada yang harus rusak, perubahan itu masuk ke /v2, dan /v1 tetap berjalan setidaknya 6 bulan sejak diumumkan.
Nama tool dan input wajibnya mengikuti aturan yang sama. Tool baru dan input opsional bisa muncul kapan saja; client
mendapatkannya dari tools/list.