Deprecation
DeprecationУстаревание полей

Устаревание полей

Included in the “Power Extensions” bundle

При обновлении наших схем GraphQL некоторые поля могут стать ненужными, возможно, заменёнными более совершенной реализацией. В таком случае мы можем пометить устаревшие поля как deprecated, предоставив причину устаревания, которая будет информировать и побуждать пользователей переходить на новое поле в своих клиентах.

Это расширение предоставляет пользовательский интерфейс для пометки полей как устаревших.

Описание

На сайт добавляется новый пользовательский тип записи «Список устаревания полей». Его записи можно просматривать на странице «Списки устаревания полей» в меню, а для добавления новой записи в редакторе следует нажать «Добавить новый список устаревания полей».

Списки устаревания полей
Списки устаревания полей

Редактор списка устаревания полей

Каждый список устаревания полей содержит одну или несколько записей, каждая из которых включает следующие элементы:

  • Поля, которые нужно пометить как устаревшие
  • Причина устаревания (отображается в ответе GraphQL при запросе устаревшего поля)

Запись об устаревании поля

После создания списка устаревания полей можно настроить пользовательский Endpoint и Persisted Query на его использование, отредактировав соответствующую конфигурацию схемы и выбрав нужный элемент из списка в блоке «Списки устаревания полей».

Выбор списка устаревания полей в конфигурации схемы