Nous publions des mises à jour fréquentes de notre documentation, et la traduction de cette page peut encore être en cours. Pour obtenir les informations les plus actuelles, consultez la documentation anglaise.
Pour les API Événements de problème et Chronologie, découvrez chaque type d’événement, l’action de déclenchement sur GitHub, et les propriétés uniques de chaque événement.
Les événements de problème sont déclenchés par l’activité dans les problèmes et les demandes de tirage, et sont disponibles dans l’API Événements de problème et API Événements de chronologie. Chaque type d’événement spécifie si l’événement est disponible dans les API Événements de problème ou Événements de chronologie.
L’API REST GitHub traite chaque demande de tirage comme un problème, mais ne traite pas chaque problème comme une demande de tirage. Pour cette raison, les points de terminaison Événements de problème et Événements de chronologie peuvent retourner des problèmes et des demandes de tirage dans la réponse. Les demandes de tirage ont une propriété pull_request dans l’objet issue. Comme les demandes de tirage sont des problèmes, les numéros de demande de tirage et de problème ne se chevauchent pas dans un dépôt. Par exemple, si vous ouvrez votre premier problème dans un dépôt, son numéro est 1. Si vous ouvrez ensuite une demande de tirage, son numéro est 2. Chaque type d’événement spécifie si l’événement se produit dans une demande de tirage, des problèmes ou les deux.
Propriétés courantes des objets d’événement de problème
Les événements de problème ont tous la même structure d’objet, à l’exception des événements qui sont disponibles seulement dans l’API Événements de chronologie. Certains événements comprennent également des propriétés supplémentaires qui fournissent plus de contexte sur les ressources d’événement. Consultez l’événement spécifique pour plus d’informations sur les propriétés qui diffèrent de ce format d’objet.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
added_to_project
Le problème ou la demande de tirage ont été ajoutés à un tableau de projet. Vous ne voyez cet événement que dans les réponses lorsque les tableaux de projet ont été activés dans le référentiel.
Disponibilité
Type de problème
API Événements de problème
API Événements de chronologie
Problèmes
Demande de tirage (pull request)
X
X
Propriétés de l’objet d’événement
Remarque : des détails de carte de projet sont désormais présentés dans des réponses de l’API REST pour des événements de problème et de chronologie liés au projet. Cette fonctionnalité est désormais disponible en préversion pour les développeurs. Pour plus de détails, consultez ce billet de blog.
Pour recevoir l’attribut project_card, les tableaux de projet doivent être activés pour un dépôt, et vous devez fournir un type de média personnalisé dans l’en-tête Accept :
application/vnd.github.starfox-preview+json
Avertissement : l’API peut changer sans préavis pendant la période de préversion. Les fonctionnalités en préversion ne sont pas prises en charge pour une utilisation en production. Si vous rencontrez des problèmes, contactez votre propriétaire d’entreprise.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit. assignee
assigner
object
La personne qui a effectué la désaffectation pour ce problème. Ce champ est disponible dans l’API Événements de problème, mais pas dans l’API Événements de chronologie.
automatic_base_change_failed
GitHub n’a pas réussi à changer automatiquement la branche de base de la demande de tirage.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
Fermé
Le problème ou la demande de tirage ont été fermés. Quand commit_id est présent, il identifie le commit qui a fermé le problème en utilisant la syntaxe « closes / fixes ». Pour plus d’informations sur la syntaxe, consultez « Liaison d’une demande de tirage à un problème ».
Le problème ou la demande de tirage ont été liés à un autre problème ou une autre demande de tirage. Pour plus d’informations, consultez « Liaison d’une demande de tirage à un problème ».
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
converted_note_to_issue
Le problème a été créé en convertissant une note du tableau de projet en problème. Vous ne voyez cet événement que dans les réponses lorsque les tableaux de projet ont été activés dans le référentiel.
Disponibilité
Type de problème
API Événements de problème
API Événements de chronologie
Problèmes
X
X
Propriétés de l’objet d’événement
Remarque : des détails de carte de projet sont désormais présentés dans des réponses de l’API REST pour des événements de problème et de chronologie liés au projet. Cette fonctionnalité est désormais disponible en préversion pour les développeurs. Pour plus de détails, consultez ce billet de blog.
Pour recevoir l’attribut project_card, les tableaux de projet doivent être activés pour un dépôt, et vous devez fournir un type de média personnalisé dans l’en-tête Accept :
application/vnd.github.starfox-preview+json
Avertissement : l’API peut changer sans préavis pendant la période de préversion. Les fonctionnalités en préversion ne sont pas prises en charge pour une utilisation en production. Si vous rencontrez des problèmes, contactez votre propriétaire d’entreprise.
Horodatage indiquant quand la référence croisée a été ajoutée.
updated_at
string
Horodatage indiquant quand la référence croisée a été mise à jour ou créée, si la référence croisée n’est jamais mise à jour.
source
object
Le problème ou la demande de tirage qui a ajouté une référence croisée.
source[type]
string
Cette valeur est toujours "issue", car les demandes de tirage sont toujours de type problème. Seuls les événements de référence croisée déclenchés par des problèmes ou des demandes de tirage sont retournés dans l’API Événements de chronologie. Pour déterminer si le problème qui a déclenché l’événement est une demande de tirage, vous pouvez vérifier si l’objet source[issue][pull_request] existe.
source[issue]
object
Objet issue qui a ajouté la référence croisée.
event
string
La valeur de l’événement est "cross-referenced".
demilestoned
Le problème ou la demande de tirage ont été supprimés d’un jalon.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
déconnecté
Le problème ou la demande de tirage ont été dissociés d’un autre problème ou d’une autre demande de tirage. Pour plus d’informations, consultez « Liaison d’une demande de tirage à un problème ».
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
marked_as_duplicate
Un utilisateur avec des autorisations d’écriture a marqué un problème comme doublon d’un autre problème, ou une demande de tirage comme doublon d’une autre demande de tirage.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
fusionnées
La demande de tirage a été fusionnée. L’attribut commit_id est le SHA1 du commit HEAD qui a été fusionné. Le commit_repository est toujours identique au dépôt principal.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit. milestone
milestone[title]
string
Titre du jalon.
moved_columns_in_project
Le problème ou la demande de tirage ont été déplacés entre les colonnes d’un tableau de projet. Vous ne voyez cet événement que dans les réponses lorsque les tableaux de projet ont été activés dans le référentiel.
Disponibilité
Type de problème
API Événements de problème
API Événements de chronologie
Problèmes
Demandes de tirage
X
X
Propriétés de l’objet d’événement
Remarque : des détails de carte de projet sont désormais présentés dans des réponses de l’API REST pour des événements de problème et de chronologie liés au projet. Cette fonctionnalité est désormais disponible en préversion pour les développeurs. Pour plus de détails, consultez ce billet de blog.
Pour recevoir l’attribut project_card, les tableaux de projet doivent être activés pour un dépôt, et vous devez fournir un type de média personnalisé dans l’en-tête Accept :
application/vnd.github.starfox-preview+json
Avertissement : l’API peut changer sans préavis pendant la période de préversion. Les fonctionnalités en préversion ne sont pas prises en charge pour une utilisation en production. Si vous rencontrez des problèmes, contactez votre propriétaire d’entreprise.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
referenced
Le problème a été référencé à partir d’un message de commit. L’attribut commit_id est le SHA1 de commit de l’endroit où cela s’est produit et le commit_repository est l’endroit où ce commit a été envoyé.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit.
removed_from_project
Le problème ou la demande de tirage ont été supprimés d’un tableau de projet. Vous ne voyez cet événement que dans les réponses lorsque les tableaux de projet ont été activés dans le référentiel.
Disponibilité
Type de problème
API Événements de problème
API Événements de chronologie
Problèmes
Demandes de tirage
X
X
Propriétés de l’objet d’événement
Remarque : des détails de carte de projet sont désormais présentés dans des réponses de l’API REST pour des événements de problème et de chronologie liés au projet. Cette fonctionnalité est désormais disponible en préversion pour les développeurs. Pour plus de détails, consultez ce billet de blog.
Pour recevoir l’attribut project_card, les tableaux de projet doivent être activés pour un dépôt, et vous devez fournir un type de média personnalisé dans l’en-tête Accept :
application/vnd.github.starfox-preview+json
Avertissement : l’API peut changer sans préavis pendant la période de préversion. Les fonctionnalités en préversion ne sont pas prises en charge pour une utilisation en production. Si vous rencontrez des problèmes, contactez votre propriétaire d’entreprise.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit. dismissed_review
dismissed_review[state]
string
État dans lequel se trouvait la demande de tirage lorsqu'elle a été rejetée. Il peut s’agir de l’une des valeurs suivantes : commented, approved ou changes_requested.
dismissed_review[review_id]
string
Identificateur unique de la révision de demande de tirage.
dismissed_review[dismissal_message]
string
Message inclus par l’utilisateur lors de l’abandon de la révision.
dismissed_review[dismissal_commit_id]
string
Identificateur unique de la validation qui a ignoré la révision, le cas échéant.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit. assignee
assigner
object
La personne qui a effectué la désaffectation pour ce problème. Ce champ est disponible dans l’API Événements de problème, mais pas dans l’API Événements de chronologie.
URL de l’API REST pour récupérer (fetch) l’événement.
actor
object
Personne qui a généré l’événement.
event
string
Identifie le type réel d’événement qui s’est produit.
commit_id
string
SHA de la validation qui a référencé ce problème.
commit_url
string
Lien de l’API REST GitHub vers la validation qui a référencé ce problème.
created_at
string
Timestamp indiquant quand l’événement s’est produit. lock_reason
unmarked_as_duplicate
Le problème qu’un utilisateur avait précédemment marqué comme doublon d’un autre problème n’est plus considéré comme un doublon, ou la demande de tirage que l’utilisateur avait précédemment marquée comme doublon d’une autre demande de tirage n’est plus considérée comme un doublon.