Migrazione dalla versione V2 alpha

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

Guida introduttiva alla versione V2 beta

Se utilizzi già la V2 Alpha, non devi eseguire alcuna configurazione aggiuntiva per iniziare a utilizzare la versione V2 Alpha. Puoi usare gli stessi account/credenziali di servizio e l'API sarà già abilitata per te.

Per chiamare gli endpoint V2 beta, sostituisci semplicemente la parte /v2alpha/ dell'URL della richiesta con /v2beta/. Ad esempio, ecco come eseguire l'upgrade di una chiamata cases.get da V2 Alpha a V2 Beta:

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

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

Modifiche che interessano le classificazioni delle richieste di assistenza

Importante: si tratta dell'unica modifica che provoca un errore di distribuzione tra V2 Alpha e V2 Beta. È possibile eseguire in modo sicuro la migrazione a V2 beta di qualsiasi endpoint non menzionato in questa sezione senza alcuna modifica alla logica di business o al formato di richiesta/risposta.

L'unico comportamento che è cambiato da V2 Alpha a V2 Beta è il tipo di Classificazione della richiesta.

Classificazione case V2 Alpha

Campo	Obbligatorio per la creazione di richieste	Descrizione
productType	Sì	string Il tipo di prodotto a cui corrisponde la classificazione.
value	Sì	string La classificazione da utilizzare durante la creazione di una richiesta, ad esempio "Problemi tecnici >Compute > Compute Engine"

Classificazione case V2 Beta

Campo	Obbligatorio per la creazione di richieste	Descrizione
id	Sì	string L'ID univoco di una classificazione. Deve essere specificato per la creazione della richiesta.
displayName	NO	string Il nome visualizzato della classificazione.

Perché abbiamo apportato queste modifiche?

• Rimozione del campo productType

  • Un progetto iniziale dell'API ci ha imposto di aggiungere questo campo, ma con l'evoluzione dell'API è diventato obsoleto.
  • Questo campo è obbligatorio, ma l'unico valore valido è GOOGLE_CLOUD. Viene così aggiunto boilerplate a ogni richiesta di creazione di una richiesta.

• Separazione di value in id e displayName in corso...

  • Il campo value in V2 Alpha deve essere leggibile dall'utente (in modo che un essere umano possa scegliere dall'elenco di opzioni) e leggibile dal computer (in modo che la nostra API possa indicare il tipo di richiesta in fase di creazione).
  • La versione beta di V2 separa questi problemi in due campi. id è la parte leggibile della macchina nella classificazione, displayName è la parte leggibile dall'uomo.
  • Questo ci offre la flessibilità di apportare modifiche al nome visualizzato senza interrompere le integrazioni API. Ad esempio, potremmo voler avere più traduzioni di displayName in futuro, ma id rimarrebbe lo stesso per tutte le traduzioni, dato che rappresentano la stessa classificazione dei casi.