Ce journal des modifications présente les modifications significatives apportées au guide de conception d'API.
2021-12
- Modification de la terminologie "API réseau" en "API réseau" pour assurer la cohérence avec https://google.aip.dev/9.
2021-09
- Documentation des formats d'erreur de l'API Google v1 et v2.
2021-04
Introduction de la gestion des versions basée sur la visibilité.
Introduction du titre de l'API dans le glossaire.
2021-03
Ajout d'une annotation pour les champs de sortie uniquement.
Mise à jour des instructions de valeur d'énumération pour inclure toujours une valeur
_UNSPECIFIED
explicite.Ajout d'instructions sur la façon de générer et d'analyser des noms de ressources.
Ajout de
progress_percent
aux champs standards.
2021-02
- Ajout de conseils sur les champs primitifs
optional
proto3.
2021-01
Mise à jour de la page "Erreurs" pour couvrir la dernière amélioration liée à
google.rpc.ErrorInfo
etgoogle.api.ErrorReason
.Ajout de conseils sur l'utilisation de
oauth2l
,curl
et des paramètres système pour résoudre les erreurs avec les API Google.Ajout de l'explication du code d'erreur
502
à la page "Erreurs". Il s'agit d'une erreur réseau au lieu d'une erreur d'API.
2020-12
- Les noms de package doivent utiliser des noms de composants singuliers pour la cohérence globale. Les noms de package ne doivent pas contenir de trait de soulignement.
2020-09
Suppression de certaines exigences pour la description des champs et remplacement du terme "doit" par "devrait" pour le document RFC 2119.
Suppression du champ standard
bool deleted
, au profit degoogle.protobuf.Timestamp delete_time
(qui était déjà répertorié).
2020-07
Mise à jour de documentation.md en fonction de l'URL https://google.aip.dev/192#formatting. Les tables Markdown et le code HTML brut ne doivent pas être utilisés dans les commentaires proto.
Ajout de
ErrorInfo
pour la gestion des erreurs.Ajout de charges utiles volumineuses pour les modèles de conception.
2020-04
- Remplacement du terme "API Google Cloud" par "API Cloud" dans le glossaire.
- Définition des termes "API" et "service" comme synonymes de "service d'API".
2020-02
- Mise à jour des informations sur la gestion des versions pour ajouter deux stratégies (la gestion des versions stables et la gestion des versions déployées). Suppression des indications sur les versions ponctuelles et modification de la définition de ce que l'on appelle "gestion sémantique des versions".
2020-01
- Ajout de la fonctionnalité de conservation des données aux modèles de conception.
2019-11
- Ajout du terme API Cloud au glossaire.
- Recommander aux clients de ne relancer la requête que pour les erreurs UNAVAILABLE.
2019-06
- Ajout de la section "Champs de type Bool, Enum et String" aux modèles de conception.
Mars 2019
- Ajout de paramètres système aux champs standards
Février 2019
- Ajout de noms à l'échelle du domaine aux schémas de conception
Mars 2018
- Ajout d'une sémantique de fermeture partielle en streaming aux modèles de conception.
Février 2018
- Ajout de
read_time
aux champs standards.
Janvier 2018
- Ajout d'une référence de schéma pour la définition de service de l'API.
Décembre 2017
- Clarification selon laquelle la version majeure de l'API doit être le dernier composant du nom du package proto.
Novembre 2017
- Clarification de la raison pour laquelle la méthode
Create
utilise une ressource d'entrée. - Clarification de la raison pour laquelle les ID de collection n'ont pas de forme au pluriel, tels que "temps et "météo".
- Ajout d'une ressource unique aux modèles de conception.
- Clarification des conventions d'attribution de noms en C# pour les acronymes et les versions.
Septembre 2017
- Ajout de
mime_type
aux champs standards. - Ajout de
expire_time
aux champs standards. - Ajout de
start_time
etend_time
aux champs standards.
Février 2017
- Ajout de "Point de terminaison de l'API" au glossaire.
- Ajout de
update_mask
aux champs standards. - Ajout d'un lien vers
FieldMask
aux méthodes standards. - Mention indiquant que la spécification OpenAPI n'est pas compatible avec les entiers non signés.
- Clarification précisant que les noms de méthode doivent utiliser des verbes à l’impératif.