Velden depreceren
Het versiebeheer van een GraphQL-schema houdt in dat je velden depreceert, d.w.z. de gebruiker vertelt dat het veld niet meer gebruikt moet worden en door welk ander veld het vervangen kan worden.
Naast het depreceren van velden via code biedt Gato GraphQL een gebruikersinterface om te configureren welke velden gedeprececeerd moeten worden en hoe.
De configuratie wordt aangemaakt via een velddeprecatielijst en via de schemaconfiguratie geleverd aan aangepaste endpoints en persisted queries.
Alle velddeprecatielijsten bekijken
Door op "Field Deprecation Lists" in het menu van de plugin te klikken, wordt de lijst met alle aangemaakte velddeprecatielijsten weergegeven:
Een nieuwe velddeprecatielijst aanmaken
Klik op de knop "Add New Field Deprecation List" om de WordPress-editor te openen:
Geef de velddeprecatielijst een titel, voeg vermeldingen met velden toe en configureer het deprecatiebericht. Klik wanneer je klaar bent op de knop Publish. De nieuwe velddeprecatielijst is dan beschikbaar voor de schemaconfiguratie.
Het veld wordt in het schema als gedeprececeerd gemarkeerd en bovendien wordt het deprecatiebericht weergegeven in de respons bij het opvragen van een gedeprececeerd veld (als de module Deprecation Notifier is ingeschakeld).
Velddeprecatievermelding
Elke Field Deprecation List bevat Ć©Ć©n of meer vermeldingen, elk met de volgende elementen:
- De te depreceren velden
- Het deprecatiebericht
Velden selecteren uit interfaces
Naast velden uit typen kun je ook velden selecteren uit interfaces. In dat geval wordt de deprecatie toegepast op deze velden in alle typen die de interface implementeren.
De velddeprecatielijst beschrijven
Gebruik het veld "Excerpt" in het paneel Documentinstellingen om een beschrijving te geven aan de velddeprecatielijst.
Meer informatie vind je in de gids Een beschrijving toevoegen aan de API.
De velddeprecatielijst gebruiken
Nadat je de velddeprecatielijst hebt aangemaakt, kun je ervoor zorgen dat het Custom Endpoint of de Persisted Query er gebruik van maakt door de bijbehorende schemaconfiguratie te bewerken en de ACL te selecteren uit de lijst onder het blok "Field Deprecation Lists".
Als je de configuratie niet aanpast, worden de standaard Field Deprecation Lists gebruikt die zijn gedefinieerd op de pagina Instellingen, onder het tabblad "Field Deprecation":
