doc-locale/fr-fr/api/rest/deprecations.md
Vous devez régulièrement passer en revue les dépréciations suivantes et effectuer les modifications recommandées. Ces dépréciations signalent souvent des fonctionnalités d'API améliorées et recommandent l'utilisation de nouveaux champs ou endpoints pour les fonctionnalités.
Bien que certaines dépréciations mentionnent une API REST v5, aucun développement d'API REST v5 n'est actif. GitLab n'effectuera pas ces modifications dans l'API REST v4, et suit la gestion sémantique de version pour l'API REST.
geo_nodes {#geo_nodes-api-endpoints}Changement cassant. ticket associé.
Les endpoints d'API geo_nodes sont dépréciés et sont remplacés par geo_sites. Cela fait partie du changement global sur la façon de faire référence aux déploiements Geo. Les nœuds sont renommés en sites dans toute l'application. La fonctionnalité des deux endpoints reste la même.
merged_by {#merged_by-api-field}Changement cassant. ticket associé.
Le champ merged_by dans l'API des merge requests a été déprécié en faveur du champ merge_user qui identifie plus correctement qui a fusionné un merge request lors d'actions (défini sur la fusion automatique, ajout au merge train) autres qu'une simple fusion.
Les utilisateurs de l'API sont encouragés à utiliser le nouveau champ merge_user à la place. Le champ merged_by sera supprimé dans la v5 de l'API REST GitLab.
merge_status {#merge_status-api-field}Changement cassant. ticket associé.
Le champ merge_status dans l'API des merge requests a été déprécié en faveur du champ detailed_merge_status qui identifie plus correctement tous les statuts potentiels dans lesquels un merge request peut se trouver. Les utilisateurs de l'API sont encouragés à utiliser le nouveau champ detailed_merge_status à la place. Le champ merge_status sera supprimé dans la v5 de l'API REST GitLab.
private_profile dans l'API User {#null-value-for-private_profile-attribute-in-user-api}Changement cassant. ticket associé.
Lors de la création et de la mise à jour d'utilisateurs via l'API, null était une valeur valide pour l'attribut private_profile, qui était converti en interne en valeur par défaut. Dans la v5 de l'API REST GitLab, null ne sera plus une valeur valide pour ce paramètre, et la réponse sera un 400 si utilisé. Après cette modification, les seules valeurs valides seront true et false.
Changement cassant. ticket associé.
L'endpoint pour obtenir les modifications d'un seul merge request a été déprécié en faveur de l'endpoint liste des diffs de merge request. Les utilisateurs de l'API sont encouragés à passer au nouvel endpoint de diffs à la place.
L'endpoint changes from a single merge request sera supprimé dans la v5 de l'API REST GitLab.
Changement cassant. ticket associé.
L'endpoint pour obtenir toutes les licences gérées pour un projet donné a été déprécié en faveur de la fonctionnalité politique d'approbation de licence.
Les utilisateurs qui souhaitent continuer à appliquer des approbations basées sur les licences détectées sont encouragés à créer une nouvelle politique d'approbation de licence à la place.
L'endpoint managed licenses sera supprimé dans la v5 de l'API REST GitLab.
Changement cassant. ticket associé.
L'endpoint pour obtenir la configuration des approbations d'un projet renvoie des tableaux vides pour approvers et approval_groups. Ces champs ont été dépréciés en faveur de l'endpoint pour lister toutes les règles d'approbation d'un merge request. Les utilisateurs de l'API sont encouragés à passer à cet endpoint à la place.
Ces champs seront supprimés de l'endpoint get configuration dans la v5 de l'API REST GitLab.
active par le runner remplacée par paused {#runner-usage-of-active-replaced-by-paused}Changement cassant. ticket associé.
Les occurrences de l'identifiant active dans les endpoints d'API GraphQL de GitLab Runner seront renommées en paused dans GitLab 16.0.
paused à la place de activeactive, tels que :
GET /runnersGET /runners/allGET /runners/:id / PUT /runners/:idPUT --form "active=false" /runners/:runner_idGET /projects/:id/runners / POST /projects/:id/runnersGET /groups/:id/runnersLa release 16.0 de GitLab Runner commencera à utiliser la propriété paused lors de l'enregistrement des runners.
paused {#runner-status-will-not-return-paused}Changement cassant. ticket associé.
Dans une future v5 de l'API REST, les endpoints pour GitLab Runner ne renverront pas paused ni active.
Le statut d'un runner sera uniquement lié au statut de contact du runner, tel que : online, offline, ou not_connected. Le statut paused ou active n'apparaîtra plus.
Pour vérifier si un runner est paused, les utilisateurs de l'API sont conseillés de vérifier que l'attribut booléen paused est true à la place. Pour vérifier si un runner est active, vérifiez que paused est false.
ip_address {#runner-will-not-return-ip_address}Changement cassant. ticket associé.
Dans GitLab 17.0, l'API Runners renverra "" à la place de ip_address pour les runners. Dans la v5 de l'API REST, le champ sera supprimé.
default_branch_protection {#default_branch_protection-api-field}Changement cassant. ticket associé.
Le champ default_branch_protection est déprécié dans GitLab 17.0 pour les API suivantes :
Vous devez utiliser le champ default_branch_protection_defaults à la place, qui offre un contrôle plus précis sur les protections de la branche par défaut.
Le champ default_branch_protection sera supprimé dans la v5 de l'API REST GitLab.
require_password_to_approve {#require_password_to_approve-api-field}Le champ require_password_to_approve a été déprécié dans GitLab 16.9. Utilisez le champ require_reauthentication_to_approve à la place. Si vous fournissez des valeurs pour les deux champs, le champ require_reauthentication_to_approve est prioritaire.
Le champ require_password_to_approve sera supprimé dans la v5 de l'API REST GitLab.
Changement cassant. ticket associé.
Dans GitLab 17.6, la configuration du pull mirroring avec l'API Projects est dépréciée. Elle est remplacée par une nouvelle configuration et un nouvel endpoint, projects/:id/mirror/pull.
La configuration précédente utilisant l'API Projects sera supprimée dans la v5 de l'API REST GitLab.
restrict_user_defined_variables avec l'endpoint d'API Projects {#restrict_user_defined_variables-parameter-with-the-projects-api-endpoint}Dans GitLab 17.7, le paramètre restrict_user_defined_variables dans l'API Projects est déprécié en faveur de l'utilisation exclusive de ci_pipeline_variables_minimum_override_role.
Pour reproduire le même comportement de restrict_user_defined_variables: false, définissez ci_pipeline_variables_minimum_override_role sur developer.
namespace dans les endpoints d'API d'import de projet {#namespace-parameter-in-project-import-api-endpoints}Changement cassant. ticket associé.
Dans GitLab 18.7, le paramètre namespace dans l'API d'import et d'export de projet est déprécié en faveur des paramètres namespace_id et namespace_path. Le paramètre namespace acceptait un ID ou un chemin, ce qui entraînait une ambiguïté lorsque les chemins d'espace de nommage ne contenaient que des chiffres.
À la place, vous devez utiliser :
namespace_id pour spécifier un espace de nommage par son ID numérique.namespace_path pour spécifier un espace de nommage par son chemin.Le paramètre namespace sera supprimé dans la v5 de l'API REST GitLab.