Deprecando campos
O versionamento de um schema GraphQL envolve a deprecação de campos, ou seja, informar ao usuário que o campo não deve mais ser utilizado e por qual outro campo substituí-lo.
Além de deprecar campos via código, o Gato GraphQL fornece uma interface de usuário para configurar quais campos deprecar e como fazê-lo.
A configuração é criada por meio de uma lista de deprecação de campos, e entregue aos custom endpoints e persisted queries através da configuração do schema.
Acessando todas as listas de deprecação de campos
Ao clicar em "Field Deprecation Lists" no menu do plugin, é exibida a lista de todas as listas de deprecação de campos criadas:
Criando uma nova lista de deprecação de campos
Clique no botão "Add New Field Deprecation List" para abrir o editor do WordPress:
Dê um título à lista de deprecação de campos, adicione entradas com campos e configure a mensagem de deprecação. Quando estiver pronto, clique no botão Publish. Em seguida, a nova lista de deprecação de campos ficará disponível para a configuração do schema.
O campo será marcado como deprecado no schema e, além disso, a mensagem de deprecação será exibida na resposta ao consultar um campo deprecado (se o módulo Deprecation Notifier estiver habilitado).
Entradas de deprecação de campos
Cada Field Deprecation List contém uma ou mais entradas, cada uma com os seguintes elementos:
- Os campos a deprecar
- A mensagem de deprecação
Selecionando campos de interfaces
Além de campos de tipos, também é possível selecionar campos de interfaces. Nesse caso, a deprecação é aplicada a esses campos em todos os tipos que implementam a interface.
Descrevendo a lista de deprecação de campos
Use o campo "Excerpt", no painel Document settings, para fornecer uma descrição à lista de deprecação de campos.
Encontre mais informações no guia Adicionando uma descrição à API.
Usando a lista de deprecação de campos
Após criar a lista de deprecação de campos, é possível fazer com que o Custom Endpoint ou a Persisted Query a utilize editando a Schema Configuration correspondente, e selecionando a ACL da lista no bloco "Field Deprecation Lists".
Se a configuração não for personalizada, as Field Deprecation Lists padrão definidas na página de Configurações, na aba "Field Deprecation", serão utilizadas:
