Migrar da V2 Beta

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

Começar a usar a V2

Se você já usa a V2 Beta, não precisa fazer outras configurações para começar a usar a V2. É possível usar as mesmas contas de serviço e credenciais. A API já estará ativada para você.

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

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

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

Mudanças interruptivas em SearchCases, Case.severity e Comment.plainTextBody

Importante :essas são as únicas mudanças interruptivas entre a V2 Beta e a V2. Todos os campos/endpoints não mencionados nesta seção são exatamente os mesmos. Se você não usa o endpoint SearchCases, o campo Case.severity ou o campo Comment.plainTextBody, pode migrar para a V2 com segurança sem nenhuma mudança na lógica de negócios ou no formato de solicitação-resposta.

SearchCases alterações de endpoint

O endpoint SearchCases foi alterado das seguintes maneiras:

• O caminho foi alterado de:

  GET https://cloudsupport.googleapis.com/v2/cases:search

  entre outras:

  GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search

• O parâmetro filter não aceita mais um filtro project ou organization. Em vez disso, o projeto/organização do URL vai ser usado como escopo da pesquisa.

Alterações de campo

Os campos foram alterados das seguintes maneiras:

• O campo severity em casos foi removido e substituído pelo campo priority.

• O campo plainTextBody nos comentários do caso foi removido e substituído pelo campo body.

Por que fizemos essas alterações?

• Como alterar o caminho SearchCases

  • A forma antiga de definir o escopo de pesquisa era confusa e não estava alinhada com as práticas padrão de design da API do Google Cloud Platform.
  • A nova maneira torna o SearchCases mais consistente com outros endpoints na API, como ListCases.

• Como remover o campo Case.severity

  • A gravidade tem a mesma finalidade que a prioridade, portanto, removê-la simplifica a API.

• Como remover o campo Comment.plainTextBody

  • Comment.body contém apenas texto simples. Por isso, ele é uma cópia desse campo. Por isso, vamos remover plainTextBody para simplificar a API

Como se adaptar às mudanças

• Remova os filtros project e organization das solicitações SearchCase e declare-os no URL da solicitação.

• Use o campo priority nos lugares em que você costumava usar o campo severity. Elas são muito semelhantes em significado semântico, então você geralmente pode trocar essas referências.

• Use o campo body em vez do campo plainTextBody. Elas continham as mesmas informações. Então, não há problema em substituir todas as referências a plainTextBody por body.