Migrer depuis la version 2 bêta

Cette page est destinée aux clients qui utilisent actuellement la version bêta V2 de l'API Cloud Support et qui souhaitent migrer vers la version 2.

Premiers pas avec la version 2

Si vous utilisez déjà la version 2 bêta, aucune configuration supplémentaire n'est requise pour commencer à utiliser la version 2. Vous pouvez utiliser les mêmes comptes de service et identifiants. L'API sera déjà activée pour vous.

Pour appeler les points de terminaison V2, il vous suffit de remplacer la partie /v2beta/ de l'URL de la requête par /v2/. Par exemple, voici comment mettre à niveau un appel cases.get de la version bêta de la version 2 à la version 2:

V2 Bêta : GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc

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

Modifications destructives pour SearchCases, Case.severity et Comment.plainTextBody

Important :Ce sont les seules modifications importantes entre la version 2 bêta et la version 2. Tous les champs/points de terminaison non mentionnés dans cette section sont exactement identiques. Si vous n'utilisez pas actuellement le point de terminaison SearchCases, le champ Case.severity ou le champ Comment.plainTextBody, vous pouvez migrer en toute sécurité vers V2 sans modifier votre logique métier ni votre format requête-réponse.

SearchCases modifications de point de terminaison

Le point de terminaison SearchCases a été modifié comme suit:

• Le chemin d'accès est passé de:

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

  to:

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

• Le paramètre filter n'accepte plus les filtres project ni organization. À la place, le projet/l'organisation associé à l'URL sera utilisé comme champ d'application de la recherche.

Modifications des champs

Ces champs ont été modifiés comme suit:

• Le champ severity concernant les cas a été supprimé et remplacé par le champ priority.

• Le champ plainTextBody dans les commentaires sur la demande a été supprimé et remplacé par le champ body.

Pourquoi avons-nous apporté ces modifications ?

• Modifier le chemin d'accès SearchCases

  • L'ancienne façon de définir le champ d'application de la recherche n'était pas claire et ne correspondait pas aux pratiques standards de conception des API Google Cloud Platform.
  • Cette nouvelle méthode rend SearchCases plus cohérent avec les autres points de terminaison de l'API, tels que ListCases.

• Supprimer le champ Case.severity

  • La gravité a le même rôle que la priorité. Par conséquent, sa suppression simplifie l'API.

• Supprimer le champ Comment.plainTextBody

  • Comment.body ne contient que du texte brut. Il s'agit donc d'un double de ce champ. Nous allons donc supprimer plainTextBody pour simplifier l'API.

Comment s’adapter aux changements

• Supprimez les filtres project et organization des requêtes SearchCase, et déclarez-les plutôt dans l'URL de la requête.

• Utilisez le champ priority là où vous utilisiez le champ severity. Leur signification sémantique est très similaire. Vous pouvez donc généralement les échanger.

• Utilisez le champ body au lieu du champ plainTextBody. Elles contenaient les mêmes informations. Il est donc normal de remplacer toutes les références à plainTextBody par body.