Journal des modifications de l'API de projets
Dans ce journal des modifications, vous pouvez en savoir plus sur les dernières modifications, améliorations et mises à jour de l'API de projets. Le journal des modifications répertorie les modifications effectuées en les classant par date de publication. Les modifications apportées aux versions d'API existantes sont conçues pour être compatibles avec les applications client existantes.
3 avril 2024
L'API de projets v1.0.0 est désormais disponible. Veillez à mettre à jour votre version à partir de la version bêta.
Les modifications suivantes ont un impact sur la pagination des opérations list. Pour plus d'informations, voir la section pagination de la documentation sur les API de
projets.
liste-projets
GET /v1/projects
- Le paramètre de requête de jeton de page
starta été renommé entoken.- Par exemple, l'appel de l'opération
list-projectsest passé deGET /v1/projects?limit=5&start={page_token}àGET /v1/projects?limit=5&token={page_token}.
- Par exemple, l'appel de l'opération
- La première page est renvoyée sans le paramètre de requête de jeton dans l'URL de la demande. Par exemple,
GET /v1/projects?limit=5ouGET /v1/projects.- La première page est également renvoyée lorsque le jeton de page spécifié n'est pas valide.
- Les zones
lastetpreviousne sont plus prises en charge et ne sont plus incluses dans le contenu de la réponse.
configs-liste
GET /v1/projects/{project_id}/configs
- Cette opération est maintenant mise en page.
- Une valeur par défaut de 10 enregistrements est renvoyée si la taille de page n'est pas spécifiée dans le paramètre de requête
limit.- La taille de page maximale est de 100 enregistrements.
- La première page est renvoyée sans le paramètre de requête de jeton dans l'URL de la demande. Par exemple,
GET /v1/projects/{project_id}/configs/?limit=5ouGET /v1/projects/{project_id}/configs.- La première page est également renvoyée lorsque le jeton de page spécifié n'est pas valide.
environnements de liste
GET /v1/projects/{project_id}/environments
- Cette opération est maintenant mise en page.
- Une valeur par défaut de 10 enregistrements est renvoyée si la taille de page n'est pas spécifiée dans le paramètre de requête
limit.- La taille de page maximale est de 100 enregistrements.
- La première page est renvoyée sans le paramètre de requête
tokendans l'URL de la demande. Par exemple,GET /v1/projects/{project_id}/environments/?limit=5ouGET /v1/projects/{project_id}/environments.- La première page est également renvoyée lorsque le jeton de page spécifié n'est pas valide.
Méthodes de prise en charge de l'empilement des architectures déployables
Version expérimentale
Ajout de méthodes expérimentales pour la prise en charge de l'empilement des architectures déployables.
6 novembre 2023
La dernière mise à jour inclut la modification de rupture suivante:
- Les modèles
configurationsresponsepour toutes les méthodes n'utilisent plus depipeline_state. Toutes les informations de statut d'unconfigurationsont disponibles dans la propriétéstateétendue du schéma canonique d'unconfiguration.
Modifications apportées aux projets et aux configurations
create-project: POST /v1/projects
- Les
resource_groupetlocationdoivent maintenant être imbriqués dans le contenurequest. Ils ne sont plus pris en charge en tant que paramètres de requête.
delete-config: PATCH /v1/projects/{project_id}/configs/{id}
- Le paramètre de requête
draft_onlyest obsolète. - L'API prend désormais en charge la suppression de
configurationd'un ID de projet spécifié et deversion. Voir projets#delete-config-version.
Noeuds finaux de configuration renommés
Les noeuds finaux de configuration suivants sont renommés comme suit:
POST /v1/projects/{project_id}/configs/{id}/checkest remplacé parPOST /v1/projects/{project_id}/configs/{id}/validate.POST /v1/projects/{project_id}/configs/{id}/installest remplacé parPOST /v1/projects/{project_id}/configs/{id}/deploy.POST /v1/projects/{project_id}/configs/{id}/uninstallest remplacé parPOST /v1/projects/{project_id}/configs/{id}/undeploy.
Noeuds finaux de configuration remplacés
Les méthodes drafts ont été remplacées par les opérations versions comme suit:
GET /v1/projects/{project_id}/configs/{config_id}/draftsest remplacé parGET /v1/projects/{project_id}/configs/{id}/versions.GET /v1/projects/{project_id}/configs/{config_id}/drafts/{version}est remplacé parGET /v1/projects/{project_id}/configs/{id}/versions/{version}
Etats de configuration
Le modèle d'état de configurations est mis à plat. Le pipeline_state n'est plus disponible et la propriété state est désormais étendue pour capturer tous les statuts possibles d'un configuration.
Les nouvelles valeurs state sont les suivantes:
approveddeleteddeletingdeleting_faileddiscardeddeployeddeploying_faileddeployingsupercededundeployingundeploying_failedvalidatedvalidatingvalidating_failed
Tous les noeuds finaux configuration incluent cette propriété state dans le modèle response. Pour un exemple, voir projects#get-config-version-response.
Nouvelles métadonnées de configuration
Le modèle response des opérations configurations définit désormais de nouvelles métadonnées dans la racine. Si un travail approve a été exécuté sur un configuration, une propriété approved_version est incluse dans le contenu response. De même, si un travail deploy a été exécuté sur un configuration, les métadonnées deployed_version et last_deployed sont disponibles dans
le corps response. L'exécution d'un travail validation génère les métadonnées last_validated, tandis que l'exécution d'un travail undeploy génère les métadonnées last_undeployed dans response.
25 octobre 2023
Dans les opérations projects et configurations, telles que create et update, les propriétés de définition telles que name et description doivent désormais être fournies
dans un encapsuleur definition. De même, ces propriétés ne sont désormais disponibles que dans un bloc definition dans la charge response des opérations create, update, get et list. Il s'agit d'un changement qui a été publié à l'origine le 06 juillet 2023. Les sections suivantes fournissent des informations supplémentaires sur les méthodes affectées par cette mise à jour.
Projets
create-project: POST /v1/projects
- Pour
request&response,name,descriptionetdestroy_on_deletesont désormais encapsulés dans un objetdefinition. - Les appelants de ce noeud final sont désormais censés fournir les propriétés de définition dans cet encapsuleur, par exemple:
definition: {“name”: “test”, “description”: “This is a test project”, “destroy_on_delete”: false}.- Si
destroy_on_deleten'est pas fourni, la valeur par défauttrueest affectée à une opération de création de projet.
- Si
- Voir projects#create-project-request.
- De même, dans le corps
response, les propriétés mentionnées précédemment sont désormais disponibles dans un blocdefinition.
update-project: PATCH /v1/projects/{id}
- Pour
request&response,name,descriptionetdestroy_on_deletesont désormais encapsulés dans un objetdefinition. - Les appelants de ce noeud final sont désormais censés fournir les propriétés de définition dans cet encapsuleur, par exemple:
definition: {“name”: “test_update”, “description”: “This is an updated test project“}.- Voir projects#update-project-request.
- De même, dans le corps
response, les propriétés mentionnées précédemment sont désormais disponibles dans un blocdefinition.
get-projects: GET /v1/projects/{id}
- Dans le
responsede cette opération, lesname,descriptionetdestroy_on_deletesont désormais encapsulés dans un blocdefinition.
list-project: GET /v1/projects
- Chaque projet renvoyé dans le tableau
responseencapsule les propriétésname,descriptionetdestroy_on_deletedans un blocdefinition.
Configurations
create-config: POST /v1/projects/{project_id}/configs
- Pour
request&response, les élémentslocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionsont désormais encapsulés dans un objetdefinition. - Les appelants de ce noeud final sont désormais censés fournir les propriétés de définition dans cet encapsuleur, par exemple:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Voir projets#create-config-request.
- De même, dans le corps
response, les propriétés mentionnées précédemment sont désormais disponibles dans un blocdefinition.- Une propriété
settingest également incluse dans le blocdefinition. - Voir projects#create-config-response.
- Une propriété
update-config: PATCH /v1/projects/{project_id}/configs/{id}
- Pour
request&response, les élémentslocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionsont désormais encapsulés dans un objetdefinition. - Les appelants de ce noeud final sont désormais censés fournir les propriétés de définition dans cet encapsuleur, par exemple:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Voir projets#update-config-request.
- De même, dans le corps
response, les propriétés mentionnées précédemment sont déplacées dans un blocdefinition.
get-config: GET /v1/projects/{id}
- Dans le
responsede cette opération, les élémentslocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionetsettingsont désormais encapsulés dans un objetdefinition.
list-configs: GET /v1/projects/{project_id}/configs
- Dans le
responsede cette opération, les élémentsnameetdescriptionsont désormais encapsulés dans un objetdefinition.
6 juillet 2023
Les modèles de réponse pour toutes les méthodes appliquent désormais un format de serpent en minuscules dans les valeurs state. Ce format doit être attendu dans la réponse lorsque vous appelez les noeuds finaux de projet et de configuration.
Cette mise à jour est une modification de rupture.
Les valeurs state du projet peuvent désormais être ready, deleting et deleting_failed. Pour un exemple, voir le schéma de réponse de la méthode update-project.
Les valeurs state de configuration peuvent désormais être deleted, deleting, deleting_failed, installed, installed_failed, installing, not_installed,
uninstalling, uninstalling_failed et active. Pour un exemple, voir le schéma de réponse de la méthode get-config.