Skip to main content

Requêtes de tirage empilées dans les API REST et GraphQL

Lisez et gérez les demandes de tirage empilées par programmation avec les GitHub API REST et GraphQL.

Dans cet article

Remarque

Cette fonctionnalité est disponible en préversion publique et peut être modifiée.

Les GitHub API REST et GraphQL exposent les demandes de tirage empilées. L’API REST prend en charge la lecture et la gestion des piles, tandis que l’API GraphQL prend en charge les requêtes en lecture seule.

Utilisez l’API pour lire l’appartenance à la pile d’une demande de tirage ou pour créer vos propres automatisations et intégrations pour les demandes de tirage empilées.

API REST

L’API REST expose les demandes de tirage empilées de deux façons :

  • Objet stack sur les ressources de demande de tirage (pull request). Lorsqu’une demande de tirage appartient à une pile, sa ressource REST inclut un stack objet. Cela vous permet de lire l’appartenance à la pile de la demande de tirage, y compris le nombre et la taille de la pile, ainsi que la position et la base de la demande de tirage, directement à partir de la demande de tirage.
  • API Stacks. Ensemble dédié de points de terminaison pour répertorier, lire, créer, étendre et dissolution des piles. Il s’agit de la surface permettant de créer et de modifier des piles.

Remarque

Si vous fusionnez via l’API et que vous souhaitez utiliser des demandes de tirage empilées, vous devez mettre à jour votre code pour utiliser la nouvelle API de fusion pour les piles.

Pour les points de terminaison, les paramètres et les schémas, consultez Points de terminaison d’API REST pour les pull requests.

GraphQL API

L’API GraphQL expose l’appartenance à la pile d’une demande de tirage via des champs et stackEntry en lecture seule stack sur le PullRequest type. Utilisez ces champs pour interroger la pile à laquelle une demande de tirage appartient et sa position dans celle-ci.

L’API GraphQL est en lecture seule pour les piles ; il n’y a pas de mutations de pile. Pour créer ou modifier des piles, utilisez l’API REST.

Pour les champs, les objets et les schémas, consultez Requêtes de tirage.

Lectures complémentaires