Felder als veraltet markieren
Die Versionierung eines GraphQL-Schemas beinhaltet das Veralteterklären von Feldern, d.h. dem Nutzer mitzuteilen, dass das Feld nicht mehr verwendet werden soll, und durch welches andere Feld es ersetzt werden kann.
Zusätzlich zur Veralteterklärung von Feldern per Code bietet Gato GraphQL eine Benutzeroberfläche, um zu konfigurieren, welche Felder als veraltet markiert werden sollen und wie.
Die Konfiguration wird über eine Field-Deprecation-Liste erstellt und über die Schema-Konfiguration an Custom Endpoints und Persisted queries weitergegeben.
Alle Field-Deprecation-Listen aufrufen
Ein Klick auf "Field Deprecation Lists" im Menü des Plugins zeigt die Liste aller erstellten Field-Deprecation-Listen an:
Eine neue Field-Deprecation-Liste erstellen
Klicke auf die Schaltfläche "Add New Field Deprecation List", um den WordPress-Editor zu öffnen:
Gib der Field-Deprecation-Liste einen Titel, füge Einträge mit Feldern hinzu und konfiguriere die Deprecation-Nachricht. Wenn alles bereit ist, klicke auf die Schaltfläche Publish. Die neue Field-Deprecation-Liste steht dann für die Schema-Konfiguration zur Verfügung.
Das Feld wird im Schema als veraltet markiert und zusätzlich wird die Deprecation-Nachricht in der Antwort angezeigt, wenn ein veraltetes Feld abgefragt wird (sofern das Modul Deprecation Notifier aktiviert ist).
Einträge der Field-Deprecation-Liste
Jede Field Deprecation List enthält einen oder mehrere Einträge, jeweils mit den folgenden Elementen:
- Die zu veraltenden Felder
- Die Deprecation-Nachricht
Felder aus Interfaces auswählen
Neben Feldern aus Typen können auch Felder aus Interfaces ausgewählt werden. In diesem Fall wird die Veralteterklärung auf diese Felder für alle Typen angewendet, die das Interface implementieren.
Die Field-Deprecation-Liste beschreiben
Verwende das Feld "Excerpt" im Document-Settings-Panel, um der Field-Deprecation-Liste eine Beschreibung hinzuzufügen.
Weitere Informationen findest du in der Anleitung Eine Beschreibung zur API hinzufügen.
Die Field-Deprecation-Liste verwenden
Nachdem du die Field-Deprecation-Liste erstellt hast, kannst du sie vom Custom Endpoint oder der Persisted Query nutzen lassen, indem du die entsprechende Schema-Konfiguration bearbeitest und die ACL aus der Liste im Block "Field Deprecation Lists" auswählst.
Wenn die Konfiguration nicht angepasst wird, werden die Standard-Field-Deprecation-Listen verwendet, die auf der Einstellungsseite unter dem Tab "Field Deprecation" definiert sind:
