Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Sekumpulan kebijakan mengatur penyusun API Data yang terkait dengan perubahan, pemberitahuan, rilis, dan penerapan versi yang melanggar.
Penerapan versi dan rilis
A release in the context of Data API builder refers to every published version of the software, identified by the Major.Minor.Patch format. These releases fall into three categories: stable, breaking change, and preview.
Tanggung Jawab Pembaruan Kontainer
Kontainer penyusun API Data tidak diperbarui secara otomatis. Pelanggan bertanggung jawab untuk memantau rilis baru, mengevaluasi kepentingan mereka (termasuk pembaruan keamanan), dan memperbarui kontainer yang disebarkan.
Keeping the container up to date is the customer’s responsibility.
Stable releases
A stable version of Data API builder is backwards compatible. Kompatibel mundur menyiratkan bahwa kode apa pun yang Anda tulis yang bergantung pada satu versi pembuat API Data dapat mengadopsi versi stabil yang lebih baru tanpa memerlukan perubahan kode apa pun untuk mempertahankan kebenaran atau fungsionalitas yang ada.
Melanggar rilis perubahan
Versi perubahan pembangun Api Data yang melanggar tidak kompatibel mundur. Mengadopsi versi perubahan yang melanggar dalam kode klien yang ada mungkin memerlukan perubahan kode untuk memastikan klien berulah persis seperti saat menargetkan versi sebelumnya.
Versi perubahan yang melanggar diumumkan melalui artikel daftar perubahan yang melanggar dan dalam deskripsi perubahan rilis GitHub. Publikasi versi kandidat pratinjau/rilis mendahului versi perubahan yang melanggar kecuali perubahan memperbaiki masalah keamanan, privasi, atau hukum yang penting. Meskipun versi pembuat Api Data sebelumnya mungkin tetap tersedia di halaman rilis GitHub, kami sarankan Anda meningkatkan ke rilis terbaru, yang mungkin menyertakan perbaikan bug.
Preview releases
Rilis pratinjau penyusun API Data diidentifikasi dengan X.Y.Z-rc skema penerapan versi. Akhiran -rc menunjukkan bahwa build adalah "kandidat rilis." Rilis pratinjau digunakan untuk mengumpulkan umpan balik tentang fitur baru dan perubahan lainnya.
Kecuali kami berencana untuk secara sengaja membuat perubahan signifikan dari versi stabil terakhir, kami menerbitkan versi pratinjau berikutnya dengan semuanya dari rilis stabil terbaru dan fitur pratinjau baru. Pembaruan penyusun Api Data berikutnya mungkin merusak beberapa fitur pratinjau baru yang kami tambahkan di antara versi pratinjau. Perilaku melanggar ini berarti Anda mungkin perlu mengubah kode Anda untuk membuat semuanya berfungsi lagi.
Versi pratinjau tidak dimaksudkan untuk penggunaan jangka panjang atau produksi. Saat versi stabil atau pratinjau baru tersedia, versi pratinjau yang lebih lama mungkin tidak dapat diakses lagi. Yang terbaik adalah menggunakan versi pratinjau hanya saat Anda secara aktif mengerjakan fitur baru dan siap untuk beralih ke versi non-pratinjau segera setelah rilis. Jika beberapa fitur dari versi pratinjau disertakan dalam versi stabil baru, fitur pratinjau yang tersisa ditambahkan ke versi pratinjau baru untuk Anda coba.
Tabel perubahan versi
Important
Kami mungkin memperkenalkan perubahan yang melanggar pada rilis minor atau patch ketika perubahan mengatasi bug produk penting, masalah hukum, keamanan, atau privasi.
| Release type | Previous Version | New Version | Notes |
|---|---|---|---|
| Breaking Change | 1.Y.Z |
2.Y.Z |
Fitur baru dan perbaikan bug bersama dengan perubahan yang melanggar. |
| Stable | 1.1.Z |
1.2.Z |
Fitur baru dan perbaikan bug tanpa perubahan yang melanggar kecuali perubahan mengatasi bug produk penting, hukum, keamanan, atau masalah privasi. |
| Stable | 1.1.1 |
1.1.2 |
Perbaikan bug tanpa fitur baru atau perubahan yang melanggar kecuali perubahan mengatasi bug produk penting, hukum, keamanan, atau masalah privasi. |
| Preview | X.Y.1-rc |
X.Y.2-rc |
Fitur pratinjau baru dan perbaikan bug. (Perubahan yang melanggar disertakan jika versi utama terbentur.) |
Breaking Changes
Untuk memprioritaskan keamanan, meningkatkan fitur, dan mempertahankan kualitas kode, versi baru perangkat lunak kami mungkin termasuk perubahan yang melanggar. Meskipun kami berusaha untuk meminimalkan perubahan ini melalui pilihan arsitektur yang cermat, perubahan tersebut masih dapat terjadi. Dalam kasus seperti itu, kami menjadikannya prioritas untuk mengumumkannya dan memberikan solusi yang mungkin.
Important
Kami mungkin membuat perubahan tanpa pemberitahuan sebelumnya jika perubahan dianggap tidak melanggar, atau jika itu adalah perubahan yang melanggar yang dilakukan untuk mengatasi bug produk penting atau masalah hukum, keamanan, atau privasi.
Apa itu perubahan yang melanggar?
Perubahan yang melanggar adalah modifikasi yang mengharuskan Anda memperbarui aplikasi untuk mencegah gangguan. Di penyusun Api Data, perubahan yang melanggar dapat mencakup perubahan pada kontrak REST API, pembuatan skema GraphQL, dan elemen lain yang memengaruhi kompatibilitas dan fungsionalitas.
Contoh perubahan yang melanggar
The following examples are a nonexhaustive list of breaking changes to Data API builder:
- Modifikasi kontrak REST API
- Perubahan dalam pembuatan skema GraphQL
- Perubahan yang memengaruhi kompatibilitas mundur
- Penghapusan atau penggantian nama API atau parameter
- Perubahan kode kesalahan
- Penyesuaian fungsionalitas definisi izin
- Penghapusan parameter, bidang permintaan, atau bidang respons yang diizinkan
- Penambahan parameter wajib atau bidang permintaan tanpa nilai default
- Modifikasi pada fungsionalitas titik akhir API yang dimaksudkan
Definisi perubahan yang tidak pecah
A non-breaking change refers to a change that can be integrated into your application without causing disruption. Perubahan yang tidak melelahkan biasanya dikomunikasikan setelah implementasi. Aplikasi Anda harus dirancang untuk menangani perubahan ini tanpa pemberitahuan sebelumnya.
Contoh Perubahan Yang Tidak Melanggar
The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:
- Pengenalan titik akhir baru
- Penambahan metode ke titik akhir yang ada
- Penggabungan bidang baru dalam respons dan permintaan
- Penyesuaian urutan bidang dalam respons
- Pengenalan header permintaan opsional
- Perubahan pada panjang data dan ukuran respons
- Perubahan pada pesan kesalahan dan kode
- Perbaikan kode respons HTTP
- Metadata ekstra dalam dokumen OpenAPI yang dihasilkan
Bagaimana cara mengomunikasikan perubahan yang melanggar?
Kami menjadikannya prioritas untuk segera memberi tahu Anda tentang melanggar perubahan. Anda dapat menemukan pemberitahuan perubahan yang melanggar dalam catatan rilis rilis pembuat API Data di GitHub.
Daftar perubahan pemisah saat ini
Perubahan yang melanggar dan penghentian fitur diumumkan dalam artikel ini.
- Mulai sekarang, tidak ada perubahan yang melanggar