Issue イベントは、Issue と pull request のアクティビティによってトリガーされ、Issue Events API と Timeline Events API で使用できます。 各イベントタイプでは、イベントが Issue イベントやタイ� ラインイベント API で使用可能かどうかを指定します。
GitHub の REST API は、すべてのプルリクエストを Issue と見なしますが、すべての Issue がプルリクエストであるとは限りません。 このため、Issue イベントエンドポイントとタイ� ラインイベントエンドポイントは、レスポンスで Issue とプルリクエストの両方を返す� �合があります。 pull request の issue オブジェクトには pull_request プロパティがあります。 プルリクエストは Issue のため、リポジトリ内で Issue とプルリクエストの番号が重複することはありません。 たとえば、リポジトリで最初の Issue を開くと、番号は 1 になります。 次にプルリクエストを開くと、番号は 2 になります。 各イベントタイプでは、イベントがプルリクエスト、Issue、またはその両方で発生するかどうかを指定します。
Issue イベントオブジェクトの共通プロパティ
タイ� ラインイベント 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 またはプルリクエストがプロジェクトボードに追� された。 このイベントは、リポジトリでプロジェクト ボードが有効になっている� �合の応答でのみ表示されます。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイ� ライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してく� さい。
project_card 属性を受け取るには、リポジトリに対してプロジェクト ボードを有効にする必要があります。また、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 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
割り当て済み
Issueまたはプルリクエストがユーザに割り当てられた。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
assigner | object | この issue からの割り当て解除を実行したユーザー。 |
automatic_base_change_failed
GitHub がプルリクエストのベースブランチを自動的に変更しようとしたが失敗した。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベント プロパティは、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 イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベント プロパティは、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 | コミットの署名の検証結果。 詳細については、「署名検証オブジェクト」を参照してく� さい。 |
event | string | イベントの値は "committed" です。 |
connected
Issue またはプルリクエストが、別の Issue またはプルリクエストにリンクされた。 詳細については、「pull request を Issue にリンクする」を参照してく� さい。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 がプロジェクトボードのメモを Issue に変換して作成された。 このイベントは、リポジトリでプロジェクト ボードが有効になっている� �合の応答でのみ表示されます。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイ� ライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してく� さい。
project_card 属性を受け取るには、リポジトリに対してプロジェクト ボードを有効にする必要があります。また、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 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
cross-referenced
Issue またはプルリクエストが、別の Issue またはプルリクエストから参照された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構� を使用しません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 型 | 説明 |
|---|
actor | object | イベントを生成したユーザ。 |
created_at | string | クロスリファレンスの追� 日時を示すタイ� スタンプ。 |
updated_at | string | クロスリファレンスが更新されていない� �合、クロスリファレンスの更新または作成時期を示すタイ� スタンプ。 |
source | object | クロスリファレンスを追� した Issue またはプルリクエスト。 |
source[type] | string | pull request は Issue 型であるため、この値は常に "issue" になります。 タイ� ラインイベント API では、Issue またはプルリクエストによってトリガーされたクロスリファレンスイベントのみが返されます。 イベントをトリガーした Issue が pull request であるかどうかを判断するには、source[issue][pull_request] オブジェクトが存在するかどうかをチェックします。 |
source[issue] | object | クロスリファレンスを追� した issue オブジェクト。 |
event | string | イベントの値は "cross-referenced" です。 |
demilestoned
Issue またはプルリクエストがマイルストーンから削除された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
milestone[title] | string | マイルストーンのタイトル。 |
deployed
プルリクエストがデプロイされた。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
head_ref_force_pushed
pull request の HEAD ブランチが強制的にプッシュされました。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
label[color] | string | 16 進数カラー コード。 |
locked
Issue またはプルリクエストがロックされた。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
mentioned
actor は Issue または pull request 本文内の @mentioned でした。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
milestone[title] | string | マイルストーンのタイトル。 |
moved_columns_in_project
Issue またはプルリクエストがプロジェクトボードの列間で移動された。 このイベントは、リポジトリでプロジェクト ボードが有効になっている� �合の応答でのみ表示されます。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイ� ライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してく� さい。
project_card 属性を受け取るには、リポジトリに対してプロジェクト ボードを有効にする必要があります。また、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 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 previous_column_name |
pinned
Issue がピン留めされた。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 またはプルリクエストがプロジェクトボードから削除された。 このイベントは、リポジトリでプロジェクト ボードが有効になっている� �合の応答でのみ表示されます。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
注: プロジェクト カードの詳細が、プロジェクト関連の Issue およびタイ� ライン イベントの REST API 応答に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細については、ブログ記事を参照してく� さい。
project_card 属性を受け取るには、リポジトリに対してプロジェクト ボードを有効にする必要があります。また、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 |
project_id | integer | プロジェクト カードの一意識別子。 |
project_url | string | プロジェクト カードを取得する REST API URL。 |
column_name | string | Issue がある列の名前。 |
renamed
Issue またはプルリクエストのタイトルが変更された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
rename[from] | string | 以前の名前。 |
rename[to] | string | 新しい名前。 |
reopened
Issue またはプルリクエストが再開された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
review_requester | object | レビューを要求したユーザー。 |
review_request_removed
プルリクエストのレビューリクエストが削除された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
review_requester | object | レビューを要求したユーザー。 |
reviewed
プルリクエストがレビューされた。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベント プロパティは、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 のいずれかにすることができます。 |
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
assigner | object | この issue からの割り当て解除を実行したユーザー。 |
unlabeled
Issue からラベルが削除された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
label[color] | string | 16 進数カラー コード。 |
unlocked
Issue がロック解除された。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 |
unmarked_as_duplicate
ユーザが以前に別の Issue の複製としてマークした Issue が重複と見なされなくなった。または、ユーザが以前に別のプルリクエストの複製としてマークしたプルリクエストが重複と見なされなくなった。
可用性
| 問題の種類 | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|
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 | イベントが発生した時刻を示すタイ� スタンプ。 |