Deprecare i campi
Il versionamento di uno schema GraphQL comporta la deprecazione dei campi, ovvero comunicare all'utente che il campo non dovrebbe più essere utilizzato e con quale altro campo sostituirlo.
Oltre a deprecare i campi tramite codice, Gato GraphQL fornisce un'interfaccia utente per configurare quali campi deprecare e come farlo.
La configurazione viene creata tramite una lista di deprecazione dei campi, e fornita ai custom endpoint e alle persisted queries tramite la configurazione dello schema.
Accedere a tutte le liste di deprecazione dei campi
Facendo clic su "Field Deprecation Lists" nel menu del plugin, viene visualizzato l'elenco di tutte le liste di deprecazione dei campi create:
Creare una nuova lista di deprecazione dei campi
Fai clic sul pulsante "Add New Field Deprecation List" per aprire l'editor di WordPress:
Assegna un titolo alla lista di deprecazione dei campi, aggiungi voci con i campi e configura il messaggio di deprecazione. Quando è tutto pronto, fai clic sul pulsante Publish. La nuova lista di deprecazione dei campi sarà quindi disponibile per la configurazione dello schema.
Il campo verrà contrassegnato come deprecato nello schema e, inoltre, il messaggio di deprecazione verrà visualizzato nella risposta quando si esegue una query su un campo deprecato (se il modulo Deprecation Notifier è abilitato).
Voci di deprecazione dei campi
Ogni Field Deprecation List contiene una o più voci, ciascuna con i seguenti elementi:
- I campi da deprecare
- Il messaggio di deprecazione
Selezionare campi dalle interfacce
Oltre ai campi dei tipi, è possibile selezionare anche campi dalle interfacce. In questo caso, la deprecazione viene applicata a questi campi per tutti i tipi che implementano l'interfaccia.
Descrivere la lista di deprecazione dei campi
Utilizza il campo "Excerpt", nel pannello Document settings, per fornire una descrizione alla lista di deprecazione dei campi.
Per ulteriori informazioni consulta la guida Aggiungere una descrizione all'API.
Utilizzare la lista di deprecazione dei campi
Dopo aver creato la lista di deprecazione dei campi, è possibile fare in modo che il Custom Endpoint o la Persisted Query la utilizzi modificando la Schema Configuration corrispondente, e selezionando l'ACL dall'elenco nel blocco "Field Deprecation Lists".
Se la configurazione non viene personalizzata, verranno utilizzate le Field Deprecation Lists predefinite definite nella pagina delle Impostazioni, nella scheda "Field Deprecation":
