issue イベントは、issue と pull request のアクティビティによってトリガーされ、issue イベントとタイムライン イベント用の REST API で使用できます。 各イベントの種類によって、イベントが issue イベントまたはタイムライン イベント用の REST API で使用可能かどうかが指定されます。
GitHub の REST API は、すべてのプルリクエストを Issue と見なしますが、すべての Issue がプルリクエストであるとは限りません。 このため、Issue イベントエンドポイントとタイムラインイベントエンドポイントは、レスポンスで Issue とプルリクエストの両方を返す場合があります。 pull request には issue オブジェクト内の pull_request プロパティがあります。 プルリクエストは Issue のため、リポジトリ内で Issue とプルリクエストの番号が重複することはありません。 たとえば、リポジトリで最初の Issue を開くと、番号は 1 になります。 次にプルリクエストを開くと、番号は 2 になります。 各イベントタイプでは、イベントがプルリクエスト、Issue、またはその両方で発生するかどうかを指定します。
Issue イベントオブジェクトの共通プロパティ
タイムライン イベント用の REST API でのみ使用可能なイベントを除いて、issue イベントはすべて同じオブジェクト構造になっています。 一部のイベントには、イベントリソースに関するより多くのコンテキストを提供する追加のプロパティも含まれています。 このオブジェクト形式とは異なるプロパティについて詳しくは、特定のイベントを参照してください。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
added_to_project
issue と pull request が Project (Classic) に追加された。 このイベントは、リポジトリでProjects (Classic)が有効になっている場合の応答にのみ表示されます。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
added_to_project のプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイムライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してください。
project_card 属性を受け取るには、リポジトリに対してProjects (Classic)を有効にする必要があり、さらに Accept ヘッダーでカスタムのメディアの種類を指定する必要があります。
application/vnd.github.starfox-preview+json
警告: この API は、プレビュー期間中は事前の通知なしに変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
project_card | object | プロジェクト カード オブジェクト。 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
割り当て済み
Issueまたはプルリクエストがユーザに割り当てられた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
assigned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
assignee | object | この問題に割り当てられたユーザー。 |
assigner | object | この issue からの割り当てを実行したユーザー。 このフィールドは、issue イベントに関する REST API では使用できますが、タイムライン イベントに関する REST API では使用できません。 |
automatic_base_change_failed
GitHub がプルリクエストのベースブランチを自動的に変更しようとしたが失敗した。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
automatic_base_change_failed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
automatic_base_change_succeeded
GitHub がプルリクエストのベースブランチを自動的に変更しようとした。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
automatic_base_change_succeeded のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
base_ref_changed
プルリクエストのベースリファレンスブランチが変更された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
base_ref_changed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
closed
Issue またはプルリクエストがクローズされた。 commit_id が存在する場合は、"closes / fixes" 構文を使用して Issue を閉じたコミットを示します。 構文の詳細については、「Pull RequestをIssueにリンクする」を参照してください。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
closed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
コメント済み
Issue またはプルリクエストにコメントが追加された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
commented のプロパティ
このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|---|---|
url | string | Issue コメントを取得する REST API URL。 |
html_url | string | Issue コメントの HTML URL。 |
issue_url | string | Issue の HTML URL。 |
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
user | object | この Issue についてコメントしたユーザ。 |
created_at | string | コメントの追加日時を示すタイムスタンプ。 |
updated_at | string | コメントが更新されていない場合に、コメントの更新または作成日時を示すタイムスタンプ。 |
author_association | string | Issue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した場合は、値は "OWNER" です。 |
body | string | コメント本文テキスト。 |
event | string | イベントの値は "commented" です。 |
actor | object | イベントを生成したユーザ。 |
コミット (committed)
コミットが pull request の HEAD ブランチに追加されました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
committed のプロパティ
このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|---|---|
sha | string | プルリクエスト内のコミットの SHA。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | コミットを取得する REST API URL。 |
html_url | string | コミットの HTML URL。 |
author | object | コミットの作者。 |
committer | object | 作者に代わってコミットしたユーザ。 |
tree | object | コミットの Git ツリー。 |
message | string | コミットメッセージ。 |
parents | array of objects | 親コミットのリスト。 |
verification | object | コミットの署名の検証結果。 詳しくは、「Git コミット用 REST API エンドポイント」を参照してください。 |
event | string | イベントの値は "committed" です。 |
connected
Issue またはプルリクエストが、別の Issue またはプルリクエストにリンクされた。 詳細については、「Pull RequestをIssueにリンクする」を参照してください。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
connected のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
convert_to_draft
プルリクエストがドラフトモードに変換された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
convert_to_draft のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
converted_note_to_issue
Issue が Project (Classic) のメモを Issue に変換して作成された。 このイベントは、リポジトリでProjects (Classic)が有効になっている場合の応答にのみ表示されます。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue |
converted_note_to_issue のプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイムライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してください。
project_card 属性を受け取るには、リポジトリに対してProjects (Classic)を有効にする必要があり、さらに Accept ヘッダーでカスタムのメディアの種類を指定する必要があります。
application/vnd.github.starfox-preview+json
警告: この API は、プレビュー期間中は事前の通知なしに変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
project_card | object | プロジェクト カード オブジェクト。 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
converted_to_discussion
問題は終了となり、ディスカッションに変換されました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue |
converted_to_discussion のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
cross-referenced
Issue またはプルリクエストが、別の Issue またはプルリクエストから参照された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
cross-referenced のプロパティ
このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|---|---|
actor | object | イベントを生成したユーザ。 |
created_at | string | クロスリファレンスの追加日時を示すタイムスタンプ。 |
updated_at | string | クロスリファレンスが更新されていない場合、クロスリファレンスの更新または作成時期を示すタイムスタンプ。 |
source | object | クロスリファレンスを追加した Issue またはプルリクエスト。 |
source[type] | string | pull request は Issue 型であるため、この値は常に "issue" になります。 タイムライン イベント用の REST API では、issue または pull request によってトリガーされたクロスリファレンス イベントのみが返されます。 イベントをトリガーした Issue が pull request であるかどうかを判断するには、source[issue][pull_request] オブジェクトが存在するかどうかをチェックします。 |
source[issue] | object | クロスリファレンスを追加した issue オブジェクト。 |
event | string | イベントの値は "cross-referenced" です。 |
demilestoned
Issue またはプルリクエストがマイルストーンから削除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
demilestoned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
milestone | object | マイルストーン オブジェクト。 |
milestone[title] | string | マイルストーンのタイトル。 |
deployed
プルリクエストがデプロイされた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
deployed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
deployment_environment_changed
プルリクエストのデプロイメント環境が変更された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
deployment_environment_changed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
切断
Issue またはプルリクエストが、別の Issue またはプルリクエストからリンク解除された。 詳細については、「Pull RequestをIssueにリンクする」を参照してください。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
disconnected のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
head_ref_deleted
pull request の HEAD ブランチが削除されました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
head_ref_deleted のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
head_ref_restored
pull request の HEAD ブランチが、最後の既知のコミットに復元されました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
head_ref_force_pushed
pull request の HEAD ブランチが強制的にプッシュされました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
head_ref_force_pushed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
ラベル付け済み
Issue またはプルリクエストにラベルが追加された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
labeled のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
label | object | 問題label[name] |
label[color] | string | 16 進数カラー コード。 |
locked
Issue またはプルリクエストがロックされた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
locked のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
lock_reason | string | Issue または pull request の会話がロックされた理由 (指定されている場合)。 |
mentioned
actor は Issue または pull request 本文内の @mentioned でした。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
mentioned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
marked_as_duplicate
書き込み権限を持つユーザが、Issue を別の Issue の複製としてマークしたか、プルリクエストを別のプルリクエストの複製としてマークした。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
marked_as_duplicate のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
マージされた
プルリクエストがマージされた。 commit_id 属性は、マージされた HEAD コミットの SHA1 です。 commit_repository は、常にメイン リポジトリと同じです。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
merged のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
milestoned
Issue またはプルリクエストがマイルストーンに追加された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
milestoned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
milestone | object | マイルストーン オブジェクト。 |
milestone[title] | string | マイルストーンのタイトル。 |
moved_columns_in_project
Issue またはプルリクエストが Project (Classic) の列間で移動された。 このイベントは、リポジトリでProjects (Classic)が有効になっている場合の応答にのみ表示されます。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
moved_columns_in_project のプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイムライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してください。
project_card 属性を受け取るには、リポジトリに対してProjects (Classic)を有効にする必要があり、さらに Accept ヘッダーでカスタムのメディアの種類を指定する必要があります。
application/vnd.github.starfox-preview+json
警告: この API は、プレビュー期間中は事前の通知なしに変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
project_card | object | プロジェクト カード オブジェクト。 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
previous_column_name | string | Issue の移動元の列の名前。 |
pinned
Issue がピン留めされた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue |
pinned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
ready_for_review
ドラフト pull request はレビューの準備完了とマークされました。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
ready_for_review のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
referenced
Issue がコミットメッセージから参照された。 commit_id 属性はそれが発生した場所のコミット SHA1 であり、commit_repository はそのコミットがプッシュされた場所です。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
referenced のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
removed_from_project
Issue またはプルリクエストが Project (Classic) から削除された。 このイベントは、リポジトリでProjects (Classic)が有効になっている場合の応答にのみ表示されます。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
removed_from_project のプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイムライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してください。
project_card 属性を受け取るには、リポジトリに対してProjects (Classic)を有効にする必要があり、さらに Accept ヘッダーでカスタムのメディアの種類を指定する必要があります。
application/vnd.github.starfox-preview+json
警告: この API は、プレビュー期間中は事前の通知なしに変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
project_card | object | プロジェクト カード オブジェクト。 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
renamed
Issue またはプルリクエストのタイトルが変更された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
renamed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
rename | object | 名前の詳細。 |
rename[from] | string | 以前の名前。 |
rename[to] | string | 新しい名前。 |
reopened
Issue またはプルリクエストが再開された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
reopened のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
review_dismissed
プルリクエストのレビューが却下された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
review_dismissed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
dismissed_review | object | 却下されたレビューの情報。 |
dismissed_review[state] | string | pull request が無視されたときの状態。 commented、approved、または changes_requested のいずれかにすることができます。 |
dismissed_review[review_id] | string | pull request のレビューの一意の識別子。 |
dismissed_review[dismissal_message] | string | レビューを閉じるときにユーザーが含めるメッセージ。 |
dismissed_review[dismissal_commit_id] | string | レビューが存在する場合にそれが無視されたコミットの一意識別子。 |
review_requested
プルリクエストのレビューがリクエストされた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
review_requested のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
requested_reviewer | object | pull request を確認するように要求されたユーザー。 |
review_requester | object | レビューを要求したユーザー。 |
review_request_removed
プルリクエストのレビューリクエストが削除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
review_request_removed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
requested_reviewer | object | pull request を確認するように要求されたユーザー。 |
review_requester | object | レビューを要求したユーザー。 |
reviewed
プルリクエストがレビューされた。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| Pull Request |
reviewed のプロパティ
このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
user | object | この Issue についてコメントしたユーザ。 |
body | string | レビューの概要テキスト。 |
commit_id | string | レビュー時のプルリクエストの最新コミットの SHA。 |
submitted_at | string | レビューの送信日時を示すタイムスタンプ。 |
state | string | サブミットされたレビューの状態。 commented、changes_requested、approved、dismissed のいずれかになります。 |
html_url | string | レビューの HTML URL。 |
pull_request_url | string | プルリクエストを取得する REST API URL。 |
author_association | string | Issue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した場合は、値は "OWNER" です。 |
_links | object | html_url と pull_request_url。 |
event | string | イベントの値は "reviewed" です。 |
subscribed
誰かが Issue またはプルリクエストの通知を受信するようにサブスクライブした。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
subscribed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
transferred
Issue が別のリポジトリに転送された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue |
transferred のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
未割り当て
ユーザが Issue から割り当て解除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
unassigned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
assignee | object | この問題から割り当てられていないユーザー。 |
assigner | object | この issue からの割り当て解除を実行したユーザー。 このフィールドは、issue イベントに関する REST API では使用できますが、タイムライン イベントに関する REST API では使用できません。 |
unlabeled
Issue からラベルが削除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
unlabeled のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
label | object | 問題label[name] |
label[color] | string | 16 進数カラー コード。 |
unlocked
Issue がロック解除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
unlocked のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
lock_reason | string | Issue または pull request の会話がロックされた理由 (指定されている場合)。 |
unmarked_as_duplicate
ユーザが以前に別の Issue の複製としてマークした Issue が重複と見なされなくなった。または、ユーザが以前に別のプルリクエストの複製としてマークしたプルリクエストが重複と見なされなくなった。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
unmarked_as_duplicate のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
unpinned
Issue がピン留め解除された。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue |
unpinned のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |
unsubscribed
誰かが Issue またはプルリクエストの通知を受信しないようにサブスクライブ解除した。
このイベントは、次の issue の種類で使用できます。
| issue イベント用の REST API | タイムライン イベント用の REST API | |
|---|---|---|
| issue | ||
| Pull Request |
unsubscribed のプロパティ
| 名前 | 種類 | 説明 |
|---|---|---|
id | integer | イベントの一意識別子。 |
node_id | string | イベントのグローバル ノード ID。 |
url | string | イベントをフェッチするためのREST API URL。 |
actor | object | イベントを生成したユーザ。 |
event | string | 発生したイベントの実際の種類を特定します。 |
commit_id | string | このIssueを参照するコミットのSHA。 |
commit_url | string | このIssueを参照するコミットへのGitHub REST APIリンク。 |
created_at | string | イベントが発生した時刻を示すタイムスタンプ。 |