Deprecar campos
Versionar un esquema GraphQL implica deprecar campos, es decir, decirle al usuario que el campo ya no debería usarse, y por qué otro campo reemplazarlo.
Además de deprecar campos mediante código, Gato GraphQL proporciona una interfaz de usuario para configurar qué campos deprecar, y cómo.
La configuración se crea mediante una lista de deprecación de campos, y se entrega a custom endpoints y persisted queries mediante la configuración del esquema.
Acceder a todas las listas de deprecación de campos
Haciendo clic en "Field Deprecation Lists" en el menú del plugin, se muestra la lista de todas las listas de deprecación de campos creadas:
Crear una nueva lista de deprecación de campos
Haz clic en el botón "Add New Field Deprecation List" para abrir el editor de WordPress:
Dale un título a la lista de deprecación de campos, añade entradas con campos, y configura el mensaje de deprecación. Cuando esté listo, haz clic en el botón Publish. Entonces, la nueva lista de deprecación de campos pasa a estar disponible para la configuración del esquema.
El campo se marcará como deprecado en el esquema y, además, el mensaje de deprecación se mostrará en la respuesta al consultar un campo deprecado (si el módulo Deprecation Notifier está habilitado).
Entradas de deprecación de campos
Cada Field Deprecation List contiene una o varias entradas, cada una de ellas con los siguientes elementos:
- Los campos a deprecar
- El mensaje de deprecación
Seleccionar campos de interfaces
Además de los campos de los tipos, también podemos seleccionar campos de interfaces. En este caso, la deprecación se ejecuta sobre estos campos de todos los tipos que implementan la interfaz.
Describir la lista de deprecación de campos
Utiliza el campo "Excerpt", del panel Document settings, para dar una descripción a la lista de deprecación de campos.
Encuentra más información en la guía Añadir una descripción a la API.
Utilizar la lista de deprecación de campos
Después de crear la lista de deprecación de campos, podemos hacer que el Custom Endpoint o Persisted Query la use editando la correspondiente Schema Configuration, y seleccionando la ACL de la lista bajo el bloque "Field Deprecation Lists".
Si no se personaliza la configuración, se usarán las Field Deprecation Lists por defecto definidas en la página de Ajustes, bajo la pestaña "Field Deprecation":
