title
GitHub
description
GitHubとの連携やGitHubイベントからワークフローをトリガーする
import { BlockInfoCard } from "@/components/ui/block-info-card"
{/* MANUAL-CONTENT-START:intro */}
GitHub は、Gitを使用したソフトウェア開発とバージョン管理のための世界最大のプラットフォームです。開発者がコードをホストしてレビューし、プロジェクトを管理し、共同でソフトウェアを構築できる協力的な環境を提供しています。
GitHubでは以下のことができます:
リポジトリのホスティング : バージョン管理機能を備えた公開または非公開リポジトリにコードを保存
コードの共同作業 : プルリクエストを使用して変更を提案し、コードをレビューし、貢献をマージ
課題の追跡 : 作業を整理しバグを追跡するための課題を作成、割り当て、管理
ワークフローの自動化 : GitHub Actionsを使用してコードの構築、テスト、デプロイを自動化
プロジェクト管理 : プロジェクトボード、マイルストーン、タスク追跡で作業を整理
コードのドキュメント化 : GitHub PagesやWikiでドキュメントを作成・維持
Simでは、GitHub統合によりエージェントがGitHubリポジトリやワークフローと直接やり取りできるようになります。これにより、コードレビュー支援、プルリクエスト管理、課題追跡、リポジトリ探索などの強力な自動化シナリオが可能になります。エージェントはリポジトリデータの取得、コード変更の分析、プルリクエストへのコメント投稿、その他のGitHub操作をプログラムで実行できます。この統合により、AIワークフローと開発プロセスの間のギャップが埋まり、エージェントと開発チーム間のシームレスな連携が実現します。
{/* MANUAL-CONTENT-END */}
GitHubをワークフローに統合します。PRの詳細取得、PRコメントの作成、リポジトリ情報の取得、最新コミットの取得が可能です。GitHub APIトークンキーが必要です。PRが作成された時、コメントされた時、またはコミットがプッシュされた時にワークフローをトリガーするトリガーモードでも使用できます。
差分や変更されたファイルを含むPRの詳細を取得します
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読みやすいPRの要約
metadata
object
ファイル変更を含む詳細なPRメタデータ
github_comment
GitHub PRにコメントを作成します
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
body
string
はい
コメント内容
pullNumber
number
はい
プルリクエスト番号
path
string
いいえ
レビューコメント用のファイルパス
position
number
いいえ
レビューコメント用の行番号
commentType
string
いいえ
コメントのタイプ(pr_commentまたはfile_comment)
line
number
いいえ
レビューコメント用の行番号
side
string
いいえ
差分の側面(LEFTまたはRIGHT)
commitId
string
いいえ
コメントするコミットのSHA
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるコメント確認
metadata
object
コメントのメタデータ
スター数、フォーク数、イシュー、主要言語など、GitHubリポジトリの包括的なメタデータを取得します。オプションの認証で公開および非公開リポジトリをサポートします。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるリポジトリの概要
metadata
object
リポジトリのメタデータ
GitHubリポジトリから最新のコミットを取得する
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
いいえ
ブランチ名(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるコミットの概要
metadata
object
コミットのメタデータ
github_issue_comment
GitHubイシューにコメントを作成する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
body
string
はい
コメント内容
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるコメント確認
metadata
object
コメントのメタデータ
github_list_issue_comments
GitHubイシューのすべてのコメントを一覧表示する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
since
string
いいえ
このISO 8601タイムスタンプ以降に更新されたコメントのみを表示
per_page
number
いいえ
ページあたりの結果数(最大100)
page
number
いいえ
ページ番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるコメント概要
metadata
object
コメントリストのメタデータ
github_update_comment
GitHubのイシューまたはプルリクエストの既存コメントを更新する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
comment_id
number
はい
コメントID
body
string
はい
更新されたコメント内容
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読める更新確認
metadata
object
更新されたコメントのメタデータ
github_delete_comment
GitHubのイシューまたはプルリクエストのコメントを削除する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
comment_id
number
はい
コメントID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読める削除確認
metadata
object
削除結果のメタデータ
github_list_pr_comments
GitHubプルリクエストのすべてのレビューコメントを一覧表示する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
sort
string
いいえ
作成日または更新日でソート
direction
string
いいえ
ソート方向(ascまたはdesc)
since
string
いいえ
この ISO 8601 タイムスタンプ以降に更新されたコメントのみを表示
per_page
number
いいえ
ページあたりの結果数(最大100)
page
number
いいえ
ページ番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるレビューコメントの概要
metadata
object
レビューコメントリストのメタデータ
GitHubリポジトリに新しいプルリクエストを作成する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
title
string
はい
プルリクエストのタイトル
head
string
はい
変更が実装されているブランチの名前
base
string
はい
変更を取り込みたいブランチの名前
body
string
いいえ
プルリクエストの説明(Markdown)
draft
boolean
いいえ
ドラフトプルリクエストとして作成
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるPR作成確認
metadata
object
プルリクエストのメタデータ
GitHubリポジトリの既存のプルリクエストを更新する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
title
string
いいえ
新しいプルリクエストのタイトル
body
string
いいえ
新しいプルリクエストの説明(Markdown)
state
string
いいえ
新しい状態(openまたはclosed)
base
string
いいえ
新しいベースブランチ名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるPR更新確認
metadata
object
更新されたプルリクエストのメタデータ
GitHubリポジトリでプルリクエストをマージする
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
commit_title
string
いいえ
マージコミットのタイトル
commit_message
string
いいえ
マージコミットメッセージに追加する詳細
merge_method
string
いいえ
マージ方法:merge、squash、またはrebase
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるマージ確認
metadata
object
マージ結果のメタデータ
GitHubリポジトリのプルリクエスト一覧を取得する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
state
string
いいえ
状態でフィルタリング:open、closed、またはall
head
string
いいえ
ヘッドユーザーまたはブランチ名でフィルタリング(形式:user:ref-nameまたはorganization:ref-name)
base
string
いいえ
ベースブランチ名でフィルタリング
sort
string
いいえ
並べ替え:created、updated、popularity、またはlong-running
direction
string
いいえ
並べ替え方向:ascまたはdesc
per_page
number
いいえ
1ページあたりの結果数(最大100)
page
number
いいえ
ページ番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるプルリクエストのリスト
metadata
object
プルリクエストリストのメタデータ
プルリクエストで変更されたファイルのリストを取得する
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
per_page
number
いいえ
1ページあたりの結果数(最大100)
page
number
いいえ
ページ番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
PRで変更されたファイルの人間が読めるリスト
metadata
object
PRファイルのメタデータ
GitHubリポジトリでプルリクエストを閉じる
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるPR閉鎖確認
metadata
object
閉じられたプルリクエストのメタデータ
プルリクエストのレビュアーをリクエストする
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
pullNumber
number
はい
プルリクエスト番号
reviewers
string
はい
レビューをリクエストするユーザーログインのカンマ区切りリスト
team_reviewers
string
いいえ
レビューをリクエストするチームスラッグのカンマ区切りリスト
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるレビュアーリクエスト確認
metadata
object
リクエストされたレビュアーのメタデータ
GitHubリポジトリからファイルの内容を取得します。1MBまでのファイルをサポートします。コンテンツはデコードされ、人間が読める形式で返されます。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
path
string
はい
リポジトリ内のファイルへのパス(例:"src/index.ts")
ref
string
いいえ
ブランチ名、タグ、またはコミットSHA(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
内容プレビュー付きの人間が読めるファイル情報
metadata
object
名前、パス、SHA、サイズ、URLを含むファイルメタデータ
GitHubリポジトリに新しいファイルを作成します。ファイルの内容は自動的にBase64エンコードされます。1MBまでのファイルをサポートしています。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
path
string
はい
ファイルが作成されるパス(例:"src/newfile.ts")
message
string
はい
このファイル作成のためのコミットメッセージ
content
string
はい
ファイルの内容(プレーンテキスト、自動的にBase64エンコードされます)
branch
string
いいえ
ファイルを作成するブランチ(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるファイル作成確認
metadata
object
ファイルとコミットのメタデータ
GitHubリポジトリ内の既存のファイルを更新します。ファイルのSHAが必要です。内容は自動的にBase64エンコードされます。1MBまでのファイルをサポートしています。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
path
string
はい
更新するファイルのパス(例:"src/index.ts")
message
string
はい
このファイル更新のためのコミットメッセージ
content
string
はい
新しいファイルの内容(プレーンテキスト、自動的にBase64エンコードされます)
sha
string
はい
置き換えられるファイルのblobのSHA(github_get_file_contentから取得)
branch
string
いいえ
ファイルを更新するブランチ(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるファイル更新の確認
metadata
object
更新されたファイルとコミットのメタデータ
GitHubリポジトリからファイルを削除します。ファイルのSHAが必要です。この操作はAPI経由で元に戻すことはできません。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
path
string
はい
削除するファイルのパス(例:"src/oldfile.ts")
message
string
はい
このファイル削除のためのコミットメッセージ
sha
string
はい
削除されるファイルのblobのSHA(github_get_file_contentから取得)
branch
string
いいえ
ファイルを削除するブランチ(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるファイル削除の確認
metadata
object
削除確認とコミットメタデータ
GitHubリポジトリ内のディレクトリの内容を取得します。ファイルとサブディレクトリのリストを返します。ルートディレクトリの内容を取得するには、パスを空にするか省略してください。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
path
string
いいえ
ディレクトリパス(例:"src/components")。ルートディレクトリの場合は空のままにします。
ref
string
いいえ
ブランチ名、タグ、またはコミットSHA(デフォルトはリポジトリのデフォルトブランチ)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるディレクトリツリー一覧
metadata
object
ディレクトリ内容のメタデータ
GitHubリポジトリ内のすべてのブランチを一覧表示します。オプションで保護ステータスでフィルタリングし、ページネーションを制御できます。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
protected
boolean
いいえ
保護ステータスによるブランチのフィルタリング
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト30)
page
number
いいえ
ページネーションのページ番号(デフォルト1)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるブランチのリスト
metadata
object
ブランチリストのメタデータ
GitHubリポジトリの特定のブランチに関する詳細情報(コミット詳細や保護状態を含む)を取得します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
はい
ブランチ名
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるブランチの詳細
metadata
object
ブランチのメタデータ
特定のコミットSHAを指すgitリファレンスを作成することで、GitHubリポジトリに新しいブランチを作成します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
はい
作成するブランチの名前
sha
string
はい
ブランチが指すコミットSHA
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるブランチ作成確認
metadata
object
Gitリファレンスのメタデータ
GitHubリポジトリからブランチを削除するには、そのgitリファレンスを削除します。保護されたブランチは削除できません。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
はい
削除するブランチの名前
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読める削除確認
metadata
object
削除メタデータ
github_get_branch_protection
特定のブランチのブランチ保護ルール(ステータスチェック、レビュー要件、制限など)を取得します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
はい
ブランチ名
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるブランチ保護の概要
metadata
object
ブランチ保護の設定
github_update_branch_protection
特定のブランチに対するブランチ保護ルールを更新します。ステータスチェック、レビュー要件、管理者への適用、プッシュ制限などを含みます。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
branch
string
はい
ブランチ名
required_status_checks
object
はい
必須ステータスチェックの設定(無効にするにはnull)。strict(ブール値)とcontexts(文字列配列)を持つオブジェクト
enforce_admins
boolean
はい
管理者に対して制限を適用するかどうか
required_pull_request_reviews
object
はい
PRレビュー要件(無効にするにはnull)。required_approving_review_count、dismiss_stale_reviews、require_code_owner_reviewsなどのオプションを持つオブジェクト
restrictions
object
はい
プッシュ制限(無効にするにはnull)。users(文字列配列)とteams(文字列配列)を持つオブジェクト
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるブランチ保護更新の概要
metadata
object
更新されたブランチ保護設定
GitHubリポジトリに新しいイシューを作成する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
title
string
はい
イシューのタイトル
body
string
いいえ
イシューの説明/本文
assignees
string
いいえ
このイシューに割り当てるユーザー名のカンマ区切りリスト
labels
string
いいえ
このイシューに追加するラベル名のカンマ区切りリスト
milestone
number
いいえ
このイシューに関連付けるマイルストーン番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるイシュー作成確認
metadata
object
イシューのメタデータ
GitHubリポジトリの既存のイシューを更新する
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
title
string
いいえ
新しいイシュータイトル
body
string
いいえ
新しいイシューの説明/本文
state
string
いいえ
イシューの状態(openまたはclosed)
labels
array
いいえ
ラベル名の配列(既存のすべてのラベルを置き換えます)
assignees
array
いいえ
ユーザー名の配列(既存のすべての担当者を置き換えます)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるイシュー更新確認
metadata
object
更新されたイシューのメタデータ
GitHubリポジトリのイシューを一覧表示します。注意:プルリクエストはGitHubではイシューとみなされるため、PRも含まれます
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
state
string
いいえ
状態でフィルタリング:open、closed、またはall(デフォルト:open)
assignee
string
いいえ
担当者のユーザー名でフィルタリング
creator
string
いいえ
作成者のユーザー名でフィルタリング
labels
string
いいえ
フィルタリングするラベル名のカンマ区切りリスト
sort
string
いいえ
並べ替え:created、updated、またはcomments(デフォルト:created)
direction
string
いいえ
並べ替え方向:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるイシューのリスト
metadata
object
イシューリストのメタデータ
GitHubリポジトリの特定のイシューに関する詳細情報を取得する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるイシューの詳細
metadata
object
詳細なイシューのメタデータ
GitHubリポジトリのイシューをクローズする
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
state_reason
string
いいえ
クローズの理由:completed(完了)またはnot_planned(予定なし)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるイシュークローズの確認
metadata
object
クローズされたイシューのメタデータ
GitHubリポジトリのイシューにラベルを追加する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
labels
string
はい
イシューに追加するラベル名のカンマ区切りリスト
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるラベル確認
metadata
object
ラベルのメタデータ
GitHubリポジトリのイシューからラベルを削除する
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
name
string
はい
削除するラベル名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読めるラベル削除確認
metadata
object
残りのラベルのメタデータ
GitHubリポジトリのイシューに担当者を追加する
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
課題番号
assignees
string
はい
課題に割り当てるユーザー名のカンマ区切りリスト
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
content
string
人間が読める担当者確認
metadata
object
担当者が更新された課題のメタデータ
GitHubリポジトリの新しいリリースを作成します。タグ名、ターゲットコミット、タイトル、説明、ドラフトまたはプレリリースにするかどうかを指定します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
tag_name
string
はい
このリリースのタグ名
target_commitish
string
いいえ
Gitタグが作成される場所を決定するコミット値を指定します。任意のブランチまたはコミットSHAを指定できます。デフォルトはリポジトリのデフォルトブランチです。
name
string
いいえ
リリースの名前
body
string
いいえ
リリースの内容を説明するテキスト(マークダウン対応)
draft
boolean
いいえ
ドラフト(未公開)リリースを作成する場合はtrue、公開リリースを作成する場合はfalse
prerelease
boolean
いいえ
プレリリースとして識別する場合はtrue、正式リリースとして識別する場合はfalse
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるリリース作成の概要
metadata
object
ダウンロードURLを含むリリースのメタデータ
既存のGitHubリリースを更新します。タグ名、ターゲットコミット、タイトル、説明、ドラフトステータス、またはプレリリースステータスを変更できます。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
release_id
number
はい
リリースの一意の識別子
tag_name
string
いいえ
タグの名前
target_commitish
string
いいえ
タグが作成される元となるコミットを指定する値
name
string
いいえ
リリースの名前
body
string
いいえ
リリースの内容を説明するテキスト(マークダウン対応)
draft
boolean
いいえ
ドラフトとして設定する場合はtrue、公開する場合はfalse
prerelease
boolean
いいえ
プレリリースとして識別する場合はtrue、正式リリースの場合はfalse
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるリリース更新の概要
metadata
object
ダウンロードURLを含む更新されたリリースのメタデータ
GitHubリポジトリのすべてのリリースを一覧表示します。タグ、名前、ダウンロードURLを含むリリース情報を返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
per_page
number
いいえ
1ページあたりの結果数(最大100)
page
number
いいえ
取得する結果のページ番号
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
要約付きの人間が読めるリリース一覧
metadata
object
リリースのメタデータ
IDで特定のGitHubリリースに関する詳細情報を取得します。アセットとダウンロードURLを含むリリースメタデータを返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
release_id
number
はい
リリースの一意識別子
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるリリースの詳細
metadata
object
ダウンロードURLを含むリリースメタデータ
IDによってGitHubリリースを削除します。これによりリリースは完全に削除されますが、関連するGitタグは削除されません。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
release_id
number
はい
削除するリリースの一意の識別子
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読める削除確認
metadata
object
削除結果のメタデータ
GitHubリポジトリ内のすべてのワークフローを一覧表示します。ID、名前、パス、状態、バッジURLなどのワークフロー詳細を返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
per_page
number
いいえ
ページあたりの結果数(デフォルト:30、最大:100)
page
number
いいえ
取得する結果のページ番号(デフォルト:1)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるワークフロー概要
metadata
object
ワークフローのメタデータ
IDまたはファイル名で特定のGitHub Actionsワークフローの詳細を取得します。名前、パス、状態、バッジURLなどのワークフロー情報を返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
workflow_id
string
はい
ワークフローID(数字)またはワークフローファイル名(例:"main.yaml")
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるワークフロー詳細
metadata
object
ワークフローのメタデータ
GitHub Actionsワークフローのワークフローディスパッチイベントをトリガーします。ワークフローにはworkflow_dispatchトリガーが設定されている必要があります。成功すると204 No Contentを返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
workflow_id
string
はい
ワークフローID(数字)またはワークフローファイル名(例:"main.yaml")
ref
string
はい
ワークフローを実行するGitリファレンス(ブランチまたはタグ名)
inputs
object
いいえ
ワークフローファイルで設定された入力キーと値
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
確認メッセージ
metadata
object
空のメタデータオブジェクト(204 No Contentレスポンス)
github_list_workflow_runs
リポジトリのワークフローの実行一覧を取得します。実行者、ブランチ、イベント、ステータスによるフィルタリングをサポートしています。ステータス、結果、リンクなどの実行詳細を返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー(ユーザーまたは組織)
repo
string
はい
リポジトリ名
actor
string
いいえ
ワークフローをトリガーしたユーザーでフィルタリング
branch
string
いいえ
ブランチ名でフィルタリング
event
string
いいえ
イベントタイプでフィルタリング(例:push、pull_request、workflow_dispatch)
status
string
いいえ
ステータスでフィルタリング(queued、in_progress、completed、waiting、requested、pending)
per_page
number
いいえ
1ページあたりの結果数(デフォルト:30、最大:100)
page
number
いいえ
取得する結果のページ番号(デフォルト:1)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるワークフロー実行の概要
metadata
object
ワークフロー実行のメタデータ
IDで特定のワークフロー実行に関する詳細情報を取得します。ステータス、結論、タイミング、実行へのリンクを返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
run_id
number
はい
ワークフロー実行ID
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるワークフロー実行の詳細
metadata
object
ワークフロー実行のメタデータ
github_cancel_workflow_run
ワークフロー実行をキャンセルします。キャンセルが開始された場合は202 Acceptedを返し、実行がキャンセルできない場合(すでに完了している場合など)は409 Conflictを返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
run_id
number
はい
キャンセルするワークフロー実行ID
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
キャンセル状態メッセージ
metadata
object
キャンセルのメタデータ
ワークフロー実行を再実行します。オプションで再実行時のデバッグログを有効にできます。成功すると201 Createdを返します。
パラメータ
型
必須
説明
owner
string
はい
リポジトリの所有者(ユーザーまたは組織)
repo
string
はい
リポジトリ名
run_id
number
はい
再実行するワークフロー実行ID
enable_debug_logging
boolean
いいえ
再実行時のデバッグログを有効にする(デフォルト:false)
apiKey
string
はい
GitHub個人アクセストークン
パラメータ
型
説明
content
string
再実行確認メッセージ
metadata
object
再実行メタデータ
組織またはユーザーのGitHub Projects V2を一覧表示します。ID、タイトル、番号、URL、ステータスなどの詳細を含む最大20のプロジェクトを返します。
パラメータ
型
必須
説明
owner_type
string
はい
オーナータイプ:組織の場合は「org」、ユーザーの場合は「user」
owner_login
string
はい
組織またはユーザーのログイン名
apiKey
string
はい
プロジェクト読み取り権限を持つGitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるプロジェクトリスト
metadata
object
プロジェクトのメタデータ
番号で特定のGitHub Project V2の詳細情報を取得します。ID、タイトル、説明、URL、ステータスなどのプロジェクト詳細を返します。
パラメータ
型
必須
説明
owner_type
string
はい
オーナータイプ:組織の場合は「org」、ユーザーの場合は「user」
owner_login
string
はい
組織またはユーザーのログイン名
project_number
number
はい
プロジェクト番号
apiKey
string
はい
プロジェクト読み取り権限を持つGitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読めるプロジェクトの詳細
metadata
object
プロジェクトのメタデータ
GitHub Project V2を新規作成します。オーナーのノードID(ログイン名ではない)が必要です。作成されたプロジェクトのID、タイトル、URLを返します。
パラメータ
型
必須
説明
owner_id
string
はい
オーナーのノードID(形式:PVT_... または MDQ6...)。組織またはユーザーログインからこのIDを取得するには、GitHub GraphQL APIを使用してください。
title
string
はい
プロジェクトのタイトル
apiKey
string
はい
プロジェクト書き込み権限を持つGitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読める確認メッセージ
metadata
object
作成されたプロジェクトのメタデータ
既存のGitHub Project V2を更新します。タイトル、説明、可視性(公開)、またはステータス(クローズ)を更新できます。プロジェクトのノードIDが必要です。
パラメータ
型
必須
説明
project_id
string
はい
プロジェクトのノードID(形式:PVT_...)
title
string
いいえ
新しいプロジェクトのタイトル
shortDescription
string
いいえ
新しいプロジェクトの短い説明
project_public
boolean
いいえ
プロジェクトの可視性を設定(true = 公開、false = 非公開)
closed
boolean
いいえ
プロジェクトのステータスを設定(true = クローズ、false = オープン)
apiKey
string
はい
プロジェクト書き込み権限を持つGitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読める確認メッセージ
metadata
object
更新されたプロジェクトのメタデータ
GitHub Project V2を削除します。このアクションは永続的であり、元に戻すことはできません。プロジェクトのNode IDが必要です。
パラメータ
型
必須
説明
project_id
string
はい
プロジェクトNode ID(形式:PVT_...)
apiKey
string
はい
プロジェクト管理権限を持つGitHub個人アクセストークン
パラメータ
型
説明
content
string
人間が読める確認メッセージ
metadata
object
削除されたプロジェクトのメタデータ
パラメータ
型
必須
説明
q
string
はい
オプションの修飾子を含む検索クエリ(repo:、language:、path:、extension:、user:、org:)
sort
string
いいえ
インデックス日付で並べ替え(デフォルト:最適一致)
order
string
いいえ
並べ替え順序:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
total_count
number
一致する結果の総数
incomplete_results
boolean
結果が不完全かどうか
items
array
GitHub APIからのコード一致の配列
↳ name
string
ファイル名
↳ path
string
ファイルパス
↳ sha
string
Blob SHA
↳ url
string
API URL
↳ git_url
string
Git blob URL
↳ html_url
string
GitHub Web URL
↳ score
number
検索関連性スコア
↳ repository
object
コードを含むリポジトリ
↳ id
number
リポジトリID
↳ node_id
string
GraphQLノードID
↳ name
string
リポジトリ名
↳ full_name
string
フルネーム(owner/repo)
↳ private
boolean
リポジトリがプライベートかどうか
↳ html_url
string
GitHub Web URL
↳ description
string
リポジトリの説明
↳ fork
boolean
フォークかどうか
↳ url
string
API URL
↳ owner
object
リポジトリのオーナー
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ text_matches
array
コンテキストを示すテキスト一致
↳ object_url
string
オブジェクトURL
↳ object_type
string
オブジェクトタイプ
↳ property
string
一致したプロパティ
↳ fragment
string
一致を含むテキストフラグメント
↳ matches
array
一致インデックス
↳ text
string
一致したテキスト
↳ indices
array
開始および終了インデックス
GitHub全体でコミットを検索します。repo:owner/name、author:user、committer:user、author-date:>2023-01-01などの修飾子を使用します
パラメータ
型
必須
説明
q
string
はい
オプションの修飾子を含む検索クエリ(repo:、author:、committer:、author-date:、committer-date:、merge:true/false)
sort
string
いいえ
並べ替え:author-dateまたはcommitter-date(デフォルト:最適一致)
order
string
いいえ
並べ替え順序:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
total_count
number
一致する結果の総数
incomplete_results
boolean
結果が不完全かどうか
items
array
GitHub APIからのコミットオブジェクトの配列
↳ sha
string
コミットSHA
↳ node_id
string
GraphQLノードID
↳ html_url
string
WebURL
↳ url
string
API URL
↳ comments_url
string
コメントAPI URL
↳ score
number
検索関連性スコア
↳ commit
object
コアコミットデータ
↳ url
string
コミットAPI URL
↳ message
string
コミットメッセージ
↳ comment_count
number
コメント数
↳ author
object
Git作成者
↳ name
string
作成者名
↳ email
string
作成者メールアドレス
↳ date
string
作成日(ISO 8601)
↳ committer
object
Gitコミッター
↳ name
string
コミッター名
↳ email
string
コミッターメールアドレス
↳ date
string
コミット日(ISO 8601)
↳ tree
object
ツリーオブジェクト
↳ sha
string
ツリーSHA
↳ url
string
ツリーAPI URL
↳ author
object
GitHubユーザー(作成者)
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバターURL
↳ url
string
API URL
↳ html_url
string
プロフィールURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ committer
object
GitHubユーザー(コミッター)
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバターURL
↳ url
string
API URL
↳ html_url
string
プロフィールURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ repository
object
コミットを含むリポジトリ
↳ id
number
リポジトリID
↳ node_id
string
GraphQLノードID
↳ name
string
リポジトリ名
↳ full_name
string
フルネーム(owner/repo)
↳ private
boolean
リポジトリがプライベートかどうか
↳ html_url
string
GitHub Web URL
↳ description
string
リポジトリの説明
↳ owner
object
リポジトリのオーナー
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ parents
array
親コミット
↳ sha
string
親SHA
↳ url
string
親API URL
↳ html_url
string
親Web URL
GitHub全体でイシューとプルリクエストを検索します。repo:owner/name、is:issue、is:pr、state:open、label:bug、author:userなどの修飾子を使用できます
パラメータ
型
必須
説明
q
string
はい
オプションの修飾子を含む検索クエリ(repo:、is:issue、is:pr、state:、label:、author:、assignee:)
sort
string
いいえ
並べ替え:comments、reactions、created、updated、interactions(デフォルト:最適一致)
order
string
いいえ
並べ替え順序:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
1ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
total_count
number
一致する結果の総数
incomplete_results
boolean
結果が不完全かどうか
items
array
GitHub APIからのイシュー/PRオブジェクトの配列
↳ id
number
イシューID
↳ node_id
string
GraphQLノードID
↳ number
number
イシュー番号
↳ title
string
タイトル
↳ state
string
状態(openまたはclosed)
↳ locked
boolean
イシューがロックされているかどうか
↳ html_url
string
WebのURL
↳ url
string
API URL
↳ repository_url
string
リポジトリAPI URL
↳ comments_url
string
コメントAPI URL
↳ body
string
本文テキスト
↳ comments
number
コメント数
↳ score
number
検索関連性スコア
↳ created_at
string
作成タイムスタンプ
↳ updated_at
string
最終更新タイムスタンプ
↳ closed_at
string
クローズタイムスタンプ
↳ user
object
イシュー作成者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ labels
array
イシューラベル
↳ id
number
ラベルID
↳ node_id
string
GraphQLノードID
↳ url
string
API URL
↳ name
string
ラベル名
↳ description
string
ラベルの説明
↳ color
string
16進数カラーコード
↳ default
boolean
これがデフォルトラベルかどうか
↳ assignee
object
主担当者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ assignees
array
すべての担当者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ milestone
object
関連するマイルストーン
↳ id
number
マイルストーンID
↳ node_id
string
GraphQLノードID
↳ number
number
マイルストーン番号
↳ title
string
マイルストーンタイトル
↳ description
string
マイルストーンの説明
↳ state
string
状態(openまたはclosed)
↳ html_url
string
WebのURL
↳ due_on
string
期限
↳ pull_request
object
プルリクエストの詳細(これがPRの場合)
↳ url
string
API URL
↳ html_url
string
WebのURL
↳ diff_url
string
差分URL
↳ patch_url
string
パッチURL
GitHub全体でリポジトリを検索します。language:python、stars:>1000、topic:react、user:owner、org:nameなどの修飾子を使用できます
パラメータ
型
必須
説明
q
string
はい
オプションの修飾子を含む検索クエリ(language:、stars:、forks:、topic:、user:、org:、in:name,description,readme)
sort
string
いいえ
並べ替え:stars、forks、help-wanted-issues、updated(デフォルト:最適一致)
order
string
いいえ
並べ替え順序:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
total_count
number
一致する結果の総数
incomplete_results
boolean
結果が不完全かどうか
items
array
GitHub APIからのリポジトリオブジェクトの配列
↳ id
number
リポジトリID
↳ node_id
string
GraphQLノードID
↳ name
string
リポジトリ名
↳ full_name
string
フルネーム(owner/repo)
↳ private
boolean
リポジトリがプライベートかどうか
↳ description
string
リポジトリの説明
↳ html_url
string
GitHubウェブURL
↳ url
string
API URL
↳ fork
boolean
これがフォークかどうか
↳ created_at
string
作成タイムスタンプ
↳ updated_at
string
最終更新タイムスタンプ
↳ pushed_at
string
最終プッシュタイムスタンプ
↳ size
number
リポジトリサイズ(KB)
↳ stargazers_count
number
スター数
↳ watchers_count
number
ウォッチャー数
↳ forks_count
number
フォーク数
↳ open_issues_count
number
オープンイシュー数
↳ language
string
主要なプログラミング言語
↳ default_branch
string
デフォルトブランチ名
↳ visibility
string
リポジトリの可視性
↳ archived
boolean
リポジトリがアーカイブされているかどうか
↳ disabled
boolean
リポジトリが無効化されているかどうか
↳ score
number
検索関連性スコア
↳ topics
array
リポジトリのトピック
↳ license
object
ライセンス情報
↳ key
string
ライセンスキー(例:mit)
↳ name
string
ライセンス名
↳ spdx_id
string
SPDX識別子
↳ owner
object
リポジトリのオーナー
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
GitHub上のユーザーと組織を検索します。type:user、type:org、followers:>1000、repos:>10、location:cityなどの修飾子を使用できます
パラメータ
型
必須
説明
q
string
はい
オプションの修飾子を含む検索クエリ(type:user/org、followers:、repos:、location:、language:、created:)
sort
string
いいえ
並べ替え:followers、repositories、joined(デフォルト:最適一致)
order
string
いいえ
並べ替え順序:ascまたはdesc(デフォルト:desc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
total_count
number
一致する結果の総数
incomplete_results
boolean
結果が不完全かどうか
items
array
GitHub APIからのユーザーオブジェクトの配列
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ login
string
ユーザー名
↳ avatar_url
string
アバター画像URL
↳ gravatar_id
string
Gravatar ID
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ followers_url
string
フォロワーAPI URL
↳ following_url
string
フォロー中API URL
↳ gists_url
string
Gists API URL
↳ starred_url
string
スター付きAPI URL
↳ repos_url
string
リポジトリAPI URL
↳ organizations_url
string
組織API URL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ score
number
検索関連性スコア
SHA、パス、作成者、コミッター、または日付範囲による任意のフィルタリングを使用して、リポジトリ内のコミットを一覧表示します
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
sha
string
いいえ
コミットの一覧表示を開始するSHAまたはブランチ
path
string
いいえ
このファイルパスを含むコミットのみ
author
string
いいえ
作成者でフィルタリングするGitHubログインまたはメールアドレス
committer
string
いいえ
コミッターでフィルタリングするGitHubログインまたはメールアドレス
since
string
いいえ
この日付以降のコミットのみ(ISO 8601形式)
until
string
いいえ
この日付以前のコミットのみ(ISO 8601形式)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
items
array
GitHub APIからのコミットオブジェクトの配列
↳ commit
object
コアコミットデータ
↳ url
string
コミットAPI URL
↳ message
string
コミットメッセージ
↳ comment_count
number
コメント数
↳ author
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ committer
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ tree
object
ツリーオブジェクト
↳ sha
string
ツリーSHA
↳ url
string
ツリーAPI URL
↳ verification
object
署名検証
↳ verified
boolean
署名が検証されているかどうか
↳ reason
string
検証理由
↳ signature
string
GPG署名
↳ payload
string
署名されたペイロード
↳ author
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ committer
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ sha
string
コミットSHA
↳ node_id
string
GraphQLノードID
↳ html_url
string
GitHub Web URL
↳ url
string
API URL
↳ comments_url
string
コメントAPI URL
↳ parents
array
親コミット
↳ sha
string
親SHA
↳ url
string
親API URL
↳ html_url
string
親Web URL
count
number
返されたコミット数
変更されたファイルと統計情報を含む特定のコミットの詳細情報を取得
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
ref
string
はい
コミットSHA、ブランチ名、またはタグ名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
commit
object
コアコミットデータ
↳ url
string
コミットAPI URL
↳ message
string
コミットメッセージ
↳ comment_count
number
コメント数
↳ author
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ committer
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ tree
object
ツリーオブジェクト
↳ sha
string
ツリーSHA
↳ url
string
ツリーAPI URL
↳ verification
object
署名検証
↳ verified
boolean
署名が検証されているかどうか
↳ reason
string
検証理由
↳ signature
string
GPG署名
↳ payload
string
署名されたペイロード
author
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
committer
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
stats
object
変更統計
↳ additions
number
追加された行数
↳ deletions
number
削除された行数
↳ total
number
合計変更数
sha
string
コミットSHA
node_id
string
GraphQLノードID
html_url
string
GitHub Web URL
url
string
API URL
comments_url
string
コメントAPI URL
files
array
変更されたファイル(差分エントリ)
↳ sha
string
BlobのSHA
↳ filename
string
ファイルパス
↳ status
string
変更ステータス(added、removed、modified、renamed、copied、changed、unchanged)
↳ additions
number
追加された行数
↳ deletions
number
削除された行数
↳ changes
number
合計変更数
↳ blob_url
string
Blob URL
↳ raw_url
string
生ファイルURL
↳ contents_url
string
コンテンツAPI URL
↳ patch
string
差分パッチ
↳ previous_filename
string
以前のファイル名(リネームの場合)
parents
array
親コミット
↳ sha
string
親のSHA
↳ url
string
親のAPI URL
↳ html_url
string
親のWeb URL
2つのコミットまたはブランチを比較して、差分、それらの間のコミット、および変更されたファイルを確認します
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
base
string
はい
比較のベースとなるブランチ/タグ/SHA
head
string
はい
比較のヘッドとなるブランチ/タグ/SHA
per_page
number
いいえ
ファイルの1ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ファイルのページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
url
string
API URL
html_url
string
GitHub Web URL
permalink_url
string
パーマネントリンクURL
diff_url
string
差分ダウンロードURL
patch_url
string
パッチダウンロードURL
status
string
比較ステータス(ahead、behind、identical、diverged)
ahead_by
number
ヘッドがベースより進んでいるコミット数
behind_by
number
ヘッドがベースより遅れているコミット数
total_commits
number
比較における総コミット数
base_commit
object
ベースコミットオブジェクト
↳ commit
object
コアコミットデータ
↳ url
string
コミットAPI URL
↳ message
string
コミットメッセージ
↳ comment_count
number
コメント数
↳ author
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ committer
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ tree
object
ツリーオブジェクト
↳ sha
string
ツリーSHA
↳ url
string
ツリーAPI URL
↳ verification
object
署名検証
↳ verified
boolean
署名が検証されているかどうか
↳ reason
string
検証理由
↳ signature
string
GPG署名
↳ payload
string
署名されたペイロード
↳ author
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ committer
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ sha
string
コミットSHA
↳ html_url
string
Web URL
merge_base_commit
object
マージベースコミットオブジェクト
↳ sha
string
コミットSHA
↳ html_url
string
Web URL
commits
array
ベースとヘッドの間のコミット
↳ commit
object
コアコミットデータ
↳ url
string
コミットAPI URL
↳ message
string
コミットメッセージ
↳ comment_count
number
コメント数
↳ author
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ committer
object
Gitアクター(作成者/コミッター)
↳ name
string
名前
↳ email
string
メールアドレス
↳ date
string
タイムスタンプ(ISO 8601)
↳ tree
object
ツリーオブジェクト
↳ sha
string
ツリーSHA
↳ url
string
ツリーAPI URL
↳ verification
object
署名検証
↳ verified
boolean
署名が検証されているかどうか
↳ reason
string
検証理由
↳ signature
string
GPG署名
↳ payload
string
署名されたペイロード
↳ author
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ committer
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ sha
string
コミットSHA
↳ html_url
string
Web URL
files
array
変更されたファイル(差分エントリ)
↳ sha
string
BlobのSHA
↳ filename
string
ファイルパス
↳ status
string
変更ステータス(added、removed、modified、renamed、copied、changed、unchanged)
↳ additions
number
追加された行数
↳ deletions
number
削除された行数
↳ changes
number
総変更数
↳ blob_url
string
Blob URL
↳ raw_url
string
生ファイルURL
↳ contents_url
string
コンテンツAPI URL
↳ patch
string
差分パッチ
↳ previous_filename
string
以前のファイル名(リネームの場合)
1つ以上のファイルを含む新しいgistを作成
パラメータ
型
必須
説明
description
string
いいえ
gistの説明
files
json
はい
ファイル名をキー、内容を値とするJSONオブジェクト。例:{"file.txt": {"content": "Hello"}}
public
boolean
いいえ
gistを公開するかどうか(デフォルト:false)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
string
gist ID
node_id
string
GraphQLノードID
url
string
API URL
html_url
string
Web URL
forks_url
string
フォークAPI URL
commits_url
string
コミットAPI URL
git_pull_url
string
Git pull URL
git_push_url
string
Git push URL
description
string
gistの説明
public
boolean
gistが公開されているかどうか
truncated
boolean
ファイルが切り詰められているかどうか
comments
number
コメント数
comments_url
string
コメントAPI URL
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
files
object
gist内のファイル(ファイル名をキーとするオブジェクト、各ファイルにはfilename、type、language、raw_url、size、truncated、contentが含まれます)
owner
object
gistの所有者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
ファイル内容を含むGistをIDで取得
パラメータ
型
必須
説明
gist_id
string
はい
Gist ID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
files
object
Gist内のファイル(ファイル名をキーとする)
↳ filename
string
ファイル名
↳ type
string
MIMEタイプ
↳ language
string
プログラミング言語
↳ raw_url
string
生ファイルURL
↳ size
number
ファイルサイズ(バイト)
↳ truncated
boolean
内容が切り詰められているかどうか
↳ content
string
ファイル内容
owner
object
Gistの所有者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
id
string
Gist ID
node_id
string
GraphQLノードID
url
string
API URL
html_url
string
GitHub Web URL
forks_url
string
フォークAPI URL
commits_url
string
コミットAPI URL
git_pull_url
string
GitクローンURL
git_push_url
string
GitプッシュURL
description
string
Gistの説明
public
boolean
Gistが公開されているかどうか
truncated
boolean
内容が切り詰められているかどうか
comments
number
コメント数
comments_url
string
コメントAPI URL
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
ユーザーまたは認証されたユーザーのgistを一覧表示
パラメータ
型
必須
説明
username
string
いいえ
GitHubユーザー名(認証されたユーザーのgistの場合は省略)
since
string
いいえ
この時刻以降に更新されたgistのみ(ISO 8601)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
items
array
GitHub APIからのgistオブジェクトの配列
↳ files
object
gist内のファイル(ファイル名でキー付け)
↳ filename
string
ファイル名
↳ type
string
MIMEタイプ
↳ language
string
プログラミング言語
↳ raw_url
string
生ファイルURL
↳ size
number
ファイルサイズ(バイト)
↳ truncated
boolean
コンテンツが切り詰められているかどうか
↳ content
string
ファイルの内容
↳ owner
object
gistの所有者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ id
string
gist ID
↳ node_id
string
GraphQLノードID
↳ url
string
API URL
↳ html_url
string
GitHub Web URL
↳ forks_url
string
フォークAPI URL
↳ commits_url
string
コミットAPI URL
↳ git_pull_url
string
Gitクローン用URL
↳ git_push_url
string
Gitプッシュ用URL
↳ description
string
gistの説明
↳ public
boolean
gistが公開されているかどうか
↳ truncated
boolean
コンテンツが切り詰められているかどうか
↳ comments
number
コメント数
↳ comments_url
string
コメントAPI URL
↳ created_at
string
作成タイムスタンプ
↳ updated_at
string
最終更新タイムスタンプ
count
number
返されたgistの数
gistの説明またはファイルを更新します。ファイルを削除するには、filesオブジェクト内でその値をnullに設定してください
パラメータ
型
必須
説明
gist_id
string
はい
更新するgist ID
description
string
いいえ
gistの新しい説明
files
json
いいえ
ファイル名をキーとするJSONオブジェクト。削除する場合はnullに設定、更新/追加する場合はコンテンツを提供
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
string
gist ID
node_id
string
GraphQLノードID
url
string
API URL
html_url
string
Web URL
forks_url
string
フォークAPI URL
commits_url
string
コミットAPI URL
git_pull_url
string
Git pull URL
git_push_url
string
Git push URL
description
string
gistの説明
public
boolean
gistが公開されているかどうか
truncated
boolean
ファイルが切り詰められているかどうか
comments
number
コメント数
comments_url
string
コメントAPI URL
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
files
object
gist内のファイル(ファイル名をキーとするオブジェクト、各ファイルにはfilename、type、language、raw_url、size、truncated、contentが含まれます)
owner
object
gistの所有者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
IDでgistを削除
パラメータ
型
必須
説明
gist_id
string
はい
削除するgist ID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
deleted
boolean
削除が成功したかどうか
gist_id
string
削除されたgist ID
gistをフォークして自分のコピーを作成
パラメータ
型
必須
説明
gist_id
string
はい
フォークするgist ID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
string
新しいgist ID
html_url
string
WebのURL
description
string
説明
public
boolean
公開かどうか
created_at
string
作成日
owner
object
オーナー情報
files
object
ファイル
gistにスターを付ける
パラメータ
型
必須
説明
gist_id
string
はい
スターを付けるgist ID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
starred
boolean
スター付けが成功したかどうか
gist_id
string
gist ID
gistのスターを外す
パラメータ
型
必須
説明
gist_id
string
はい
スターを外すgist ID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
unstarred
boolean
スター解除が成功したかどうか
gist_id
string
gist ID
リポジトリを自分のアカウントまたは組織にフォークする
パラメータ
型
必須
説明
owner
string
はい
フォーク元のリポジトリオーナー
repo
string
はい
フォークするリポジトリ名
organization
string
いいえ
フォーク先の組織(省略すると自分のアカウントにフォークされます)
name
string
いいえ
フォークされたリポジトリのカスタム名
default_branch_only
boolean
いいえ
デフォルトブランチのみをフォークする(デフォルト:false)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
number
リポジトリID
node_id
string
GraphQLノードID
name
string
リポジトリ名
full_name
string
フルネーム(owner/repo)
private
boolean
リポジトリがプライベートかどうか
description
string
リポジトリの説明
html_url
string
GitHubウェブURL
url
string
API URL
clone_url
string
HTTPSクローンURL
ssh_url
string
SSHクローンURL
git_url
string
GitプロトコルURL
default_branch
string
デフォルトブランチ名
fork
boolean
これがフォークかどうか
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
pushed_at
string
最終プッシュタイムスタンプ
owner
object
フォークのオーナー
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
parent
object
親リポジトリ(フォーク元)
↳ login
string
ユーザー名
↳ id
number
ユーザーID
source
object
ソースリポジトリ(最終的な起源)
↳ id
number
リポジトリID
↳ full_name
string
フルネーム
↳ html_url
string
ウェブURL
リポジトリのフォークを一覧表示
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
sort
string
いいえ
並べ替え:newest、oldest、stargazers、watchers(デフォルト:newest)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
items
array
GitHub APIからのフォークリポジトリオブジェクトの配列
↳ id
number
リポジトリID
↳ node_id
string
GraphQLノードID
↳ name
string
リポジトリ名
↳ full_name
string
フルネーム(owner/repo)
↳ private
boolean
リポジトリがプライベートかどうか
↳ description
string
リポジトリの説明
↳ html_url
string
GitHub WebのURL
↳ url
string
API URL
↳ fork
boolean
これがフォークかどうか
↳ created_at
string
作成タイムスタンプ
↳ updated_at
string
最終更新タイムスタンプ
↳ pushed_at
string
最終プッシュタイムスタンプ
↳ size
number
リポジトリサイズ(KB)
↳ stargazers_count
number
スター数
↳ watchers_count
number
ウォッチャー数
↳ forks_count
number
フォーク数
↳ open_issues_count
number
オープンイシュー数
↳ language
string
主要なプログラミング言語
↳ default_branch
string
デフォルトブランチ名
↳ visibility
string
リポジトリの可視性
↳ archived
boolean
リポジトリがアーカイブされているかどうか
↳ disabled
boolean
リポジトリが無効化されているかどうか
↳ owner
object
フォークのオーナー
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
count
number
返されたフォーク数
リポジトリにマイルストーンを作成
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
title
string
はい
マイルストーンのタイトル
state
string
いいえ
状態:openまたはclosed(デフォルト:open)
description
string
いいえ
マイルストーンの説明
due_on
string
いいえ
期限日(ISO 8601形式、例:2024-12-31T23:59:59Z)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
creator
object
マイルストーン作成者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
id
number
マイルストーンID
node_id
string
GraphQLノードID
number
number
マイルストーン番号
title
string
マイルストーンのタイトル
description
string
マイルストーンの説明
state
string
状態(openまたはclosed)
url
string
API URL
html_url
string
GitHub Web URL
labels_url
string
ラベルAPI URL
due_on
string
期限日(ISO 8601)
open_issues
number
オープンなイシューの数
closed_issues
number
クローズされたイシューの数
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
closed_at
string
クローズタイムスタンプ
番号で特定のマイルストーンを取得
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
milestone_number
number
はい
マイルストーン番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
creator
object
マイルストーン作成者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
id
number
マイルストーンID
node_id
string
GraphQLノードID
number
number
マイルストーン番号
title
string
マイルストーンのタイトル
description
string
マイルストーンの説明
state
string
状態(openまたはclosed)
url
string
API URL
html_url
string
GitHub Web URL
labels_url
string
ラベルAPI URL
due_on
string
期限(ISO 8601)
open_issues
number
オープンなイシューの数
closed_issues
number
クローズされたイシューの数
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
closed_at
string
クローズタイムスタンプ
リポジトリ内のマイルストーンを一覧表示
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
state
string
いいえ
状態でフィルタリング:open、closed、all(デフォルト:open)
sort
string
いいえ
並べ替え:due_onまたはcompleteness(デフォルト:due_on)
direction
string
いいえ
並べ替え方向:ascまたはdesc(デフォルト:asc)
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
items
array
GitHub APIからのマイルストーンオブジェクトの配列
↳ creator
object
マイルストーンの作成者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ id
number
マイルストーンID
↳ node_id
string
GraphQLノードID
↳ number
number
マイルストーン番号
↳ title
string
マイルストーンのタイトル
↳ description
string
マイルストーンの説明
↳ state
string
状態(openまたはclosed)
↳ url
string
API URL
↳ html_url
string
GitHub Web URL
↳ labels_url
string
ラベルAPI URL
↳ due_on
string
期限(ISO 8601)
↳ open_issues
number
オープンなイシューの数
↳ closed_issues
number
クローズされたイシューの数
↳ created_at
string
作成タイムスタンプ
↳ updated_at
string
最終更新タイムスタンプ
↳ closed_at
string
クローズタイムスタンプ
count
number
返されたマイルストーンの数
リポジトリ内のマイルストーンを更新
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
milestone_number
number
はい
更新するマイルストーン番号
title
string
いいえ
新しいマイルストーンのタイトル
state
string
いいえ
新しい状態:openまたはclosed
description
string
いいえ
新しい説明
due_on
string
いいえ
新しい期限(ISO 8601形式)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
number
マイルストーンID
node_id
string
GraphQLノードID
number
number
マイルストーン番号
title
string
マイルストーンのタイトル
description
string
マイルストーンの説明
state
string
状態(openまたはclosed)
url
string
API URL
html_url
string
GitHub Web URL
labels_url
string
ラベルAPI URL
due_on
string
期限(ISO 8601)
open_issues
number
オープンなイシューの数
closed_issues
number
クローズされたイシューの数
created_at
string
作成タイムスタンプ
updated_at
string
最終更新タイムスタンプ
closed_at
string
クローズタイムスタンプ
creator
object
マイルストーン作成者
↳ login
string
ユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
リポジトリからマイルストーンを削除
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
milestone_number
number
はい
削除するマイルストーン番号
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
deleted
boolean
削除が成功したかどうか
milestone_number
number
削除されたマイルストーン番号
github_create_issue_reaction
イシューにリアクションを追加
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
content
string
はい
リアクションタイプ:+1(いいね)、-1(よくないね)、laugh、confused、heart、hooray、rocket、eyes
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
number
リアクションID
node_id
string
GraphQLノードID
content
string
リアクションタイプ(+1、-1、laugh、confused、heart、hooray、rocket、eyes)
created_at
string
作成タイムスタンプ
user
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ avatar_url
string
アバター画像URL
↳ html_url
string
プロフィールURL
↳ type
string
アカウントタイプ(UserまたはOrganization)
github_delete_issue_reaction
イシューからリアクションを削除
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
issue_number
number
はい
イシュー番号
reaction_id
number
はい
削除するリアクションID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
deleted
boolean
削除が成功したかどうか
reaction_id
number
削除されたリアクションID
github_create_comment_reaction
イシューコメントにリアクションを追加
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
comment_id
number
はい
コメントID
content
string
はい
リアクションタイプ:+1(いいね)、-1(よくないね)、laugh、confused、heart、hooray、rocket、eyes
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
id
number
リアクションID
node_id
string
GraphQLノードID
content
string
リアクションタイプ(+1、-1、laugh、confused、heart、hooray、rocket、eyes)
created_at
string
作成タイムスタンプ
user
object
GitHubユーザーオブジェクト
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ avatar_url
string
アバター画像URL
↳ html_url
string
プロフィールURL
↳ type
string
アカウントタイプ(UserまたはOrganization)
github_delete_comment_reaction
イシューコメントからリアクションを削除
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
comment_id
number
はい
コメントID
reaction_id
number
はい
削除するリアクションID
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
deleted
boolean
削除が成功したかどうか
reaction_id
number
削除されたリアクションID
リポジトリにスターを付ける
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
starred
boolean
スターの付与が成功したかどうか
owner
string
リポジトリのオーナー
repo
string
リポジトリ名
リポジトリからスターを削除
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
unstarred
boolean
スター解除が成功したかどうか
owner
string
リポジトリのオーナー
repo
string
リポジトリ名
リポジトリにスターを付けているかどうかを確認
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
starred
boolean
リポジトリにスターを付けているかどうか
owner
string
リポジトリのオーナー
repo
string
リポジトリ名
リポジトリにスターを付けたユーザーを一覧表示
パラメータ
型
必須
説明
owner
string
はい
リポジトリのオーナー
repo
string
はい
リポジトリ名
per_page
number
いいえ
ページあたりの結果数(最大100、デフォルト:30)
page
number
いいえ
ページ番号(デフォルト:1)
apiKey
string
はい
GitHub APIトークン
パラメータ
型
説明
items
array
GitHub APIからのユーザーオブジェクトの配列
↳ login
string
GitHubユーザー名
↳ id
number
ユーザーID
↳ node_id
string
GraphQLノードID
↳ avatar_url
string
アバター画像URL
↳ url
string
API URL
↳ html_url
string
プロフィールページURL
↳ type
string
ユーザーまたは組織
↳ site_admin
boolean
GitHubスタッフインジケーター
↳ gravatar_id
string
Gravatar ID
↳ followers_url
string
フォロワーAPI URL
↳ following_url
string
フォローAPI URL
↳ gists_url
string
Gists API URL
↳ starred_url
string
スター付きAPI URL
↳ repos_url
string
リポジトリAPI URL
count
number
返されたスターゲイザーの数