Como migrar da V2 Alfa

Esta página é destinada a clientes que usam a versão V2 Alfa da API Cloud Support e querem migrar para a V2 Beta.

Primeiros passos com o V2 Beta

Se você já usa a V2 Alfa, não precisa fazer mais nenhuma configuração para começar a usar a V2 Beta. Use as mesmas contas/credenciais de serviço, e a API já estará ativada para você.

Para chamar os endpoints da versão Beta V2, basta substituir a parte /v2alpha/ do URL da solicitação para /v2beta/. Por exemplo, veja como fazer upgrade de uma chamada cases.get da V2 Alfa para a V2 Beta:

V2 Alfa: GET https://cloudsupport.googleapis.com/v2alpha/projects/123/cases/abc

V2 Beta: GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc

Alterações interruptivas nas classificações de caso

Importante: essa é a única alteração interruptiva entre a V2 Alfa e a V2 Beta. Todos os endpoints não mencionados nesta seção podem ser migrados com segurança para a V2 Beta sem alterações na lógica de negócios ou no formato da solicitação/resposta.

O único comportamento que mudou da versão Alfa V2 para V2 Beta é o tipo Classificação de caso.

CaseClassification V2 Alfa

Campo	Obrigatório para criação do caso	Descrição
productType	Sim	string O tipo de produto a que a classificação corresponde.
value	Sim	string A classificação a ser usada ao criar um caso, por exemplo, "Problema técnico > Computação > Compute Engine"

Classificação V2 Beta

Campo	Obrigatório para criação do caso	Descrição
id	Sim	string O ID exclusivo de uma classificação. Precisa ser especificado para criação do caso.
displayName	Não	string O nome de exibição da classificação.

Por que fizemos essas alterações?

• Como remover o campo productType

  • O design antecipado da API exigiu a adição desse campo, mas conforme a API evoluiu, ela se tornou obsoleta.
  • Este campo é obrigatório, mas o único valor válido é GOOGLE_CLOUD. Isso adiciona código boilerplate a todas as solicitações de criação de casos.

• Separando value em id e displayName

  • O campo value na V2 Alpha precisa ser legível (para que uma pessoa possa escolher na lista de opções) e legível por máquina (para que nossa API possa informar o que) tipo de caso que está sendo criado).
  • O V2 Beta separa essas preocupações em dois campos. id é a parte legível pela máquina da classificação, displayName é a parte legível.
  • Isso nos dá a flexibilidade para fazer alterações no nome de exibição sem interromper integrações de API. Por exemplo, queremos ter várias traduções de displayName no futuro, mas o id permaneceria o mesmo para todas as traduções, já que elas representam a mesma classificação de caso.