Issue イベントは、Issue およびプルリクエストのアクティビティによってトリガーされ、Issue イベント API およびタイ� ラインイベント API で使用できます。 各イベントタイプでは、イベントが Issue イベントやタイ� ラインイベント API で使用可能かどうかを指定します。
GitHub の REST API は、すべてのプルリクエストを Issue と見なしますが、すべての Issue がプルリクエストであるとは限りません。 このため、Issue イベントエンドポイントとタイ� ラインイベントエンドポイントは、レスポンスで Issue とプルリクエストの両方を返す� �合があります。 プルリクエストには、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 タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイ� ラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してく� さい。
project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタ� のメディアタイプをAcceptヘッダで提供しなければなりません。
application/vnd.github.starfox-preview+json
警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった� �合には、your site administratorにお問い合わせく� さい。
| 名前 | 種類 | 説明 |
|---|
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 |
アサイン
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 | object | このIssueから割り当てを解除された人。 assigner |
automatic_base_change_failed
GitHub がプルリクエストのベースブランチを自動的に変更しようとしたが失敗した。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
automatic_base_change_succeeded
GitHub がプルリクエストのベースブランチを自動的に変更しようとした。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
base_ref_changed
プルリクエストのベースリファレンスブランチが変更された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
closed
Issue またはプルリクエストがクローズされた。 commit_id が存在する� �合、「closes / fixes」構文を使用して Issue をクローズしたコミットを識別します。 構文に関する詳しい情� �については「プルリクエストを 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
Issue またはプルリクエストにコメントが追� された。
利用の可否
| 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。 |
ユーザ | オブジェクト | この Issue についてコメントしたユーザ。 |
created_at | string | コメントの追� 日時を示すタイ� スタンプ。 |
updated_at | string | コメントが更新されていない� �合に、コメントの更新または作成日時を示すタイ� スタンプ。 |
author_association | string | Issue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した� �合、値は「OWNER」になります。 |
body | string | コメント本文テキスト。 |
event | string | イベントの値は "commented" です。 |
actor | オブジェクト | イベントを生成したユーザ。 |
committed
プルリクエストの HEAD ブランチにコミットが追� された。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベントの属性は、Issueイベントオブジェクトの共通属性と同じ構� を使いません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|
sha | string | プルリクエスト内のコミットの SHA。 |
node_id | string | イベントのグローバルノード ID。 |
url | string | コミットを取得する REST API URL。 |
html_url | string | コミットの HTML URL。 |
作者 | オブジェクト | コミットの作者。 |
コミッター | オブジェクト | 作者に代わってコミットしたユーザ。 |
ツリー | オブジェクト | コミットの Git ツリー。 |
message | string | コミットメッセージ。 |
親 | array of objects | 親コミットのリスト。 |
検証 | オブジェクト | コミットの署名の検証結果。 詳しい情� �については、「署名検証オブジェクト」を参照してく� さい。 |
event | string | イベントの値は "committed" です。 |
connected
Issue またはプルリクエストが、別の Issue またはプルリクエストにリンクされた。 詳しい情� �については「プルリクエストを 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
convert_to_draft
プルリクエストがドラフトモードに変換された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
converted_note_to_issue
Issue がプロジェクトボードのメモを Issue に変換して作成された。 プロジェクトボードがリポジトリで有効化されている� �合にのみ、レスポンス中にこのイベントが示されます。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイ� ラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してく� さい。
project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタ� のメディアタイプをAcceptヘッダで提供しなければなりません。
application/vnd.github.starfox-preview+json
警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった� �合には、your site administratorにお問い合わせく� さい。
| 名前 | 種類 | 説明 |
|---|
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 |
cross-referenced
Issue またはプルリクエストが、別の Issue またはプルリクエストから参照された。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベントの属性は、Issueイベントオブジェクトの共通属性と同じ構� を使いません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|
actor | オブジェクト | イベントを生成したユーザ。 |
created_at | string | クロスリファレンスの追� 日時を示すタイ� スタンプ。 |
updated_at | string | クロスリファレンスが更新されていない� �合、クロスリファレンスの更新または作成時期を示すタイ� スタンプ。 |
資料 | オブジェクト | クロスリファレンスを追� した Issue またはプルリクエスト。 |
source[type] | string | プルリクエストは Issue タイプのため、この値は常に "issue" になります。 タイ� ラインイベント API では、Issue またはプルリクエストによってトリガーされたクロスリファレンスイベントのみが返されます。 イベントをトリガーした Issue がプルリクエストかどうかを判断するには、source[issue][pull_request オブジェクトの有無を確認します。 |
source[issue] | オブジェクト | クロスリファレンスを追� した issue オブジェクト。 |
event | string | イベントの値は "cross-referenced" です。 |
demilestoned
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
milestone | object | マイルストーンオブジェクト。 milestone[title] |
deployed
プルリクエストがデプロイされた。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
deployment_environment_changed
プルリクエストのデプロイメント環境が変更された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
disconnected
Issue またはプルリクエストが、別の Issue またはプルリクエストからリンク解除された。 詳しい情� �については「プルリクエストを 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
head_ref_deleted
プルリクエストの HEAD ブランチが削除された。
利用の可否
| 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_restored
プルリクエストの HEAD ブランチが最後の既知のコミットに復元された。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
head_ref_force_pushed
The pull request's HEAD branch was force pushed.
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
labeled
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
label | object | Issueから差k除されたラベル label[name] |
locked
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
lock_reason | string | Issue またはプルリクエストの会話がロックされた理由（提供されている� �合）。 |
メンション
actor が Issue またはプルリクエストの本文で @mentioned された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
marked_as_duplicate
書き込み権限を持つユーザが、Issue を別の 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
merged
プルリクエストがマージされた。 commit_id 属性は、マージされた HEAD コミットのSHA1 です。 commit_repository は、常にメインリポジトリと同じです。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
milestoned
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
milestone | object | マイルストーンオブジェクト。 milestone[title] |
moved_columns_in_project
Issue またはプルリクエストがプロジェクトボードの列間で移動された。 プロジェクトボードがリポジトリで有効化されている� �合にのみ、レスポンス中にこのイベントが示されます。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイ� ラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してく� さい。
project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタ� のメディアタイプをAcceptヘッダで提供しなければなりません。
application/vnd.github.starfox-preview+json
警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった� �合には、your site administratorにお問い合わせく� さい。
| 名前 | 種類 | 説明 |
|---|
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 |
previous_column_name | string | Issue の移動元の列の名前。 |
ピン止め済み
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
ready_for_review
A draft pull request was marked as ready for review.
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
referenced
Issue がコミットメッセージから参照された。 commit_id 属性は、発生した� �所のコミット SHA1 であり、commit_repository は、そのコミットがプッシュされた� �所です。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
removed_from_project
Issue またはプルリクエストがプロジェクトボードから削除された。 プロジェクトボードがリポジトリで有効化されている� �合にのみ、レスポンス中にこのイベントが示されます。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| X | X |
イベントオブジェクトのプロパティ
ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイ� ラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してく� さい。
project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタ� のメディアタイプをAcceptヘッダで提供しなければなりません。
application/vnd.github.starfox-preview+json
警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった� �合には、your site administratorにお問い合わせく� さい。
| 名前 | 種類 | 説明 |
|---|
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 |
renamed
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
rename | object | 名前の詳細。 rename[from] |
reopened
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
review_dismissed
プルリクエストのレビューが却下された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
column_name | string | 却下されたレビューの情� �。 dismissed_review[state] |
review_requested
プルリクエストのレビューがリクエストされた。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
requested_reviewer | object | Pull Requestのレビューをリクエストされた人。 review_requester |
review_request_removed
プルリクエストのレビューリクエストが削除された。
利用の可否
| 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
requested_reviewer | object | Pull Requestのレビューをリクエストされた人。 review_requester |
reviewed
プルリクエストがレビューされた。
利用の可否
| Issue タイプ | Issue イベント API | タイ� ラインイベント API |
|---|
| | X |
イベントオブジェクトのプロパティ
このイベントの属性は、Issueイベントオブジェクトの共通属性と同じ構� を使いません。 このイベントに対しては、以下の属性が返されます。
| 名前 | 種類 | 説明 |
|---|
id | integer | イベントの一意の識別子。 |
node_id | string | イベントのグローバルノード ID。 |
ユーザ | オブジェクト | この 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 | オブジェクト | html_url および pull_request_url。 |
event | string | イベントの値は "reviewed" です。 |
subscribed
誰かが 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 | イベントが発生した時刻を示すタイ� スタンプ。 |
transferred
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
unassigned
ユーザが 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 | object | このIssueから割り当てを解除された人。 assigner |
unlabeled
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
label | object | Issueから差k除されたラベル label[name] |
unlocked
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 | イベントが発生した時刻を示すタイ� スタンプ。 |
lock_reason | string | Issue またはプルリクエストの会話がロックされた理由（提供されている� �合）。 |
unmarked_as_duplicate
ユーザが以前に別の Issue の複製としてマークした 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 タイプ | 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 タイプ | 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 | イベントが発生した時刻を示すタイ� スタンプ。 |