Fusionner une pull request avec l'API GitHub
Fusionne une pull request dans sa branche base et renvoie merged et le sha du nouveau commit. Répond 405 quand la pull request ne peut pas être fusionnée, et 409 quand le sha ne correspond plus à son head. Les dépôts qui fusionnent via une merge queue ne l'acceptent pas.
- Identifiant
- github_merge_pull_request
L'appel
POST https://connect.reportei.com/api/tools/github_merge_pull_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"owner": "<owner>",
"repo": "<repo>",
"pull_number": 1
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| owner | string | Oui | Login of the user or organization that owns the repository, the owner.login of List repositories. |
| repo | string | Oui | Name of the repository, the name of List repositories. |
| pull_number | integer | Oui | Number of the pull request, the number of List pull requests or Search issues. |
| merge_method | string | Non | How to merge. The default is merge; the repository may allow only some methods.Valeurs : merge, squash, rebase |
| commit_title | string | Non | Title of the merge commit. |
| commit_message | string | Non | Extra text for the merge commit message. |
| sha | string | Non | The head.sha of Get pull request. The merge only happens if the branch still points to it. |
Connexions possibles
Votre client connecte son compte GitHub une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/github, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/github_merge_pull_request. Il devient la définition de tool de votre agent sans conversion.
Autres tools GitHub
- Lister les dépôtsGETListe les dépôts accessibles au compte : les siens, ceux où il est collaborateur et ceux de ses organisations. Chaque élément a owner.login et name, qui sont l'owner et le repo que demandent les autres outils. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
- Rechercher des issuesGETRecherche des issues et des pull requests dans tous les dépôts que voit le compte, avec la syntaxe de recherche de GitHub dans q. Renvoie total_count et items, jusqu'à 1 000 résultats par recherche ; paginez avec page et per_page. Chaque élément a number, et repository_url se termine par l'owner et le repo de l'élément.
- Lister les issuesGETListe les issues d'un dépôt, de la plus récente à la plus ancienne. Les pull requests figurent aussi dans la liste, marquées par la clé pull_request. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
- Obtenir une issueGETRenvoie une issue, avec title, body, state, labels, assignees et milestone. Une issue déplacée vers un autre dépôt répond 301 avec sa nouvelle adresse.
- Créer une issuePOSTCrée une issue dans un dépôt et la renvoie, avec son number. Labels, assignees, milestone et type sont ignorés sans erreur quand le compte n'a pas l'accès push au dépôt. Notifie les personnes qui suivent le dépôt.
- Modifier une issuePATCHModifie une issue et la renvoie. Seuls les champs envoyés changent. Pour la fermer, envoyez state closed avec un state_reason. Labels et assignees remplacent les valeurs actuelles, et une liste vide les efface.
- Lister les commentaires d'une issueGETListe les commentaires d'une issue ou d'une pull request, du plus ancien au plus récent. Les commentaires de revue sur le code d'une pull request ne sont pas inclus. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
- Créer un commentaire d'issuePOSTAjoute un commentaire à une issue ou à une pull request et le renvoie. Notifie les participants.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
