Mendepresiasi field
Pembuatan versi skema GraphQL melibatkan pendepresiasian field, yaitu memberi tahu pengguna bahwa field tersebut tidak boleh lagi digunakan, dan field apa yang harus menggantinya.
Selain mendepresiasi field melalui kode, Gato GraphQL menyediakan antarmuka pengguna untuk mengonfigurasi field mana yang akan didepresiasi, dan bagaimana caranya.
Konfigurasi dibuat melalui daftar depresiasi field, dan dikirimkan ke custom endpoint serta persisted queries melalui konfigurasi skema.
Mengakses semua daftar depresiasi field
Klik pada "Field Deprecation Lists" di menu plugin, maka akan ditampilkan daftar semua daftar depresiasi field yang telah dibuat:
Membuat daftar depresiasi field baru
Klik tombol "Add New Field Deprecation List" untuk membuka editor WordPress:
Beri judul pada daftar depresiasi field, tambahkan entri dengan field, dan konfigurasikan pesan depresiasi. Setelah siap, klik tombol Publish. Kemudian, daftar depresiasi field yang baru tersebut akan tersedia untuk konfigurasi skema.
Field tersebut akan ditandai sebagai terdepresiasi dalam skema dan, selain itu, pesan depresiasi akan ditampilkan dalam respons saat melakukan query pada field yang terdepresiasi (jika modul Deprecation Notifier diaktifkan).
Entri Depresiasi Field
Setiap Field Deprecation List berisi satu atau beberapa entri, masing-masing dengan elemen berikut:
- Field yang akan didepresiasi
- Pesan depresiasi
Memilih field dari interface
Selain field dari tipe, kita juga dapat memilih field dari interface. Dalam hal ini, depresiasi dijalankan pada field-field tersebut dari semua tipe yang mengimplementasikan interface tersebut.
Mendeskripsikan daftar depresiasi field
Gunakan field "Excerpt", dari panel Document settings, untuk memberikan deskripsi pada daftar depresiasi field.
Temukan informasi lebih lanjut di panduan Menambahkan deskripsi ke API.
Menggunakan daftar depresiasi field
Setelah membuat daftar depresiasi field, kita dapat membuat Custom Endpoint atau Persisted Query menggunakannya dengan mengedit Schema Configuration yang sesuai, dan memilih ACL dari daftar di bawah blok "Field Deprecation Lists".
Jika tidak mengkustomisasi konfigurasi, Field Deprecation Lists default yang ditentukan di halaman Settings, di bawah tab "Field Deprecation", akan digunakan:
