Migrazione da V2 beta

Questa pagina è rivolta ai clienti che attualmente utilizzano la versione beta V2 dell'API Cloud Support e vogliono eseguire la migrazione alla versione V2.

Introduzione alla versione 2

Se utilizzi già la versione 2 beta, non devi eseguire alcuna configurazione aggiuntiva per iniziare a utilizzarla. Puoi utilizzare gli stessi account di servizio e le stesse credenziali. L'API sarà già abilitata.

Per chiamare gli endpoint V2, sostituisci la parte /v2beta/ dell'URL della richiesta con /v2/. Ad esempio, ecco come eseguire l'upgrade di una chiamata cases.get dalla versione 2 beta alla versione 2:

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

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

Modifiche che provocano un errore in SearchCases, Case.severity e Comment.plainTextBody

Importante: queste sono le uniche modifiche che provocano un errore tra la versione 2 beta e la versione 2. Tutti i campi/endpoint non menzionati in questa sezione sono esattamente gli stessi. Se al momento non utilizzi l'endpoint SearchCases, il campo Case.severity o il campo Comment.plainTextBody, puoi eseguire in sicurezza la migrazione alla V2 senza modificare la logica di business o il formato richiesta-risposta.

SearchCases modifiche agli endpoint

L'endpoint SearchCases è cambiato nei seguenti modi:

• Il percorso è cambiato da:

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

  to:

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

• Il parametro filter non accetta più un filtro project o organization. ma verrà utilizzato il progetto/l'organizzazione dall'URL come ambito della ricerca.

Modifiche dei campi

I campi sono stati modificati nei seguenti modi:

• Il campo severity per i casi è stato rimosso a favore del campo priority.

• Il campo plainTextBody relativo ai commenti alla richiesta è stato rimosso a favore del campo body.

Perché abbiamo apportato queste modifiche?

• Modifica del percorso SearchCases

  • Il vecchio modo di definire l'ambito di ricerca era poco chiaro e non era in linea con le pratiche di progettazione standard delle API della piattaforma Google Cloud.
  • Il nuovo modo rende SearchCases più coerente con altri endpoint nell'API, come ListCases.

• Rimozione del campo Case.severity

  • La gravità serve allo stesso scopo della priorità, pertanto la rimozione semplifica l'API.

• Rimozione del campo Comment.plainTextBody

  • Comment.body contiene sempre solo testo normale, pertanto è un duplicato di questo campo, pertanto stiamo rimuovendo plainTextBody per semplificare l'API.

Come adattarsi ai cambiamenti

• Rimuovi i filtri project e organization dalle richieste SearchCase e dichiarali nell'URL della richiesta.

• Utilizza il campo priority nei punti in cui hai utilizzato il campo severity. Il significato semantico è molto simile, quindi solitamente puoi sostituirli.

• Utilizza il campo body anziché il campo plainTextBody. Contengono le stesse informazioni. Pertanto, è probabile che sia corretto sostituire tutti i riferimenti a plainTextBody con body.