Устаревание полей
Версионирование схемы GraphQL предполагает объявление полей устаревшими, то есть сообщение пользователю, что поле больше не следует использовать, и указание замены.
Помимо объявления полей устаревшими через код, Gato GraphQL предоставляет пользовательский интерфейс для настройки того, какие поля объявить устаревшими и каким образом.
Конфигурация создаётся с помощью списка устаревания полей и передаётся в custom endpoints и persisted queries через конфигурацию схемы.
Доступ ко всем спискам устаревания полей
Нажав на «Field Deprecation Lists» в меню плагина, вы увидите список всех созданных списков устаревания полей:
Создание нового списка устаревания полей
Нажмите на кнопку «Add New Field Deprecation List», чтобы открыть редактор WordPress:
Дайте списку устаревания полей название, добавьте записи с полями и настройте сообщение об устаревании. Когда всё готово, нажмите кнопку Publish. После этого новый список устаревания полей станет доступен для конфигурации схемы.
Поле будет отмечено как устаревшее в схеме, а кроме того, сообщение об устаревании будет отображаться в ответе при запросе устаревшего поля (если модуль Deprecation Notifier включён).
Записи устаревания полей
Каждый Field Deprecation List содержит одну или несколько записей, каждая из которых включает следующие элементы:
- Поля для объявления устаревшими
- Сообщение об устаревании
Выбор полей из интерфейсов
Помимо полей типов, можно также выбирать поля из интерфейсов. В этом случае устаревание применяется к данным полям всех типов, реализующих интерфейс.
Описание списка устаревания полей
Используйте поле «Excerpt» на панели Document settings, чтобы добавить описание к списку устаревания полей.
Дополнительная информация приведена в руководстве Добавление описания к API.
Использование списка устаревания полей
После создания списка устаревания полей можно подключить его к Custom Endpoint или Persisted Query, отредактировав соответствующую конфигурацию схемы и выбрав ACL из списка в блоке «Field Deprecation Lists».
Если конфигурация не настроена, будут использоваться Field Deprecation Lists по умолчанию, заданные на странице настроек во вкладке «Field Deprecation»:
