Déprécier des champs
Versionner un schéma GraphQL implique de déprécier des champs, c'est-à-dire d'indiquer à l'utilisateur que le champ ne devrait plus être utilisé, et par quel autre champ le remplacer.
En plus de déprécier des champs via le code, Gato GraphQL fournit une interface utilisateur pour configurer quels champs déprécier, et comment.
La configuration est créée via une liste de dépréciation de champs, et transmise aux custom endpoints et aux persisted queries via la configuration du schéma.
Accéder à toutes les listes de dépréciation de champs
En cliquant sur "Field Deprecation Lists" dans le menu du plugin, la liste de toutes les listes de dépréciation de champs créées s'affiche :
Créer une nouvelle liste de dépréciation de champs
Cliquez sur le bouton "Add New Field Deprecation List" pour ouvrir l'éditeur WordPress :
Donnez un titre à la liste de dépréciation de champs, ajoutez des entrées avec des champs, et configurez le message de dépréciation. Lorsque c'est prêt, cliquez sur le bouton Publish. La nouvelle liste de dépréciation de champs devient alors disponible pour la configuration du schéma.
Le champ sera marqué comme déprécié dans le schéma et, en outre, le message de dépréciation s'affichera dans la réponse lors de l'interrogation d'un champ déprécié (si le module Deprecation Notifier est activé).
Entrées de dépréciation de champs
Chaque Field Deprecation List contient une ou plusieurs entrées, chacune comportant les éléments suivants :
- Les champs à déprécier
- Le message de dépréciation
Sélectionner des champs depuis des interfaces
En plus des champs issus des types, nous pouvons également sélectionner des champs issus d'interfaces. Dans ce cas, la dépréciation s'applique à ces champs pour tous les types implémentant l'interface.
Décrire la liste de dépréciation de champs
Utilisez le champ "Excerpt", du panneau Document settings, pour donner une description à la liste de dépréciation de champs.
Retrouvez plus d'informations dans le guide Ajouter une description à l'API.
Utiliser la liste de dépréciation de champs
Après avoir créé la liste de dépréciation de champs, nous pouvons faire en sorte que le Custom Endpoint ou la Persisted Query l'utilise en modifiant la Schema Configuration correspondante, et en sélectionnant l'ACL dans la liste sous le bloc "Field Deprecation Lists".
Si la configuration n'est pas personnalisée, les Field Deprecation Lists par défaut définies sur la page des Réglages, sous l'onglet "Field Deprecation", seront utilisées :
