GitHub

GitHub は、Git リポジトリに対する Web ベースのホスティング サービスです。 Git の配布されたリビジョン管理のすべておよびソース コード管理 (SCM) 機能を提供したり、独自の機能を追加したりします。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate 標準 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps 標準 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Connector Metadata
発行者 マイクロソフト
Web サイト https://github.com/

コネクタ github アプリ発行者

このコネクタは aaptapps アカウントでアプリを使用します

コネクタの詳細

コネクタの詳細については、詳細セクション を参照してください。

既知の問題と制限事項

トリガーは、認証されたユーザーに割り当てられた所有リポジトリとメンバー リポジトリの間で課題アイテムを検索します。 組織リポジトリはサポートされていません。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒
トリガー ポーリングの頻度 1 15 秒

アクション

2 つのコミットを比較する (プレビュー)

basehead の両方が repositoryName 内でブランチ名である必要があります。 repositoryName として同じネットワークの他のリポジトリの間でブランチを比較するには、形式 <USERNAME>:branch を使用します。 応答は git log base..head の実行と同様ですが、コミットは時系列で返されます。

GitHub Webhook を削除する (プレビュー)

GitHub Webhook を削除する

ID でリポジトリを取得する (プレビュー)

ID でリポジトリを取得します。

pull request から要求済みレビュー担当者を削除する (プレビュー)

プル要求で要求されたレビューアーを、指定されたユーザーやチームから削除します。

イシューに割り当て可能な担当者をリポジトリから一覧で表示する

イシューに割り当て可能な担当者をリポジトリから一覧で表示します。

イシューのすべてのラベルを一覧表示する

イシューのすべてのラベルを一覧で表示します。

イシューを作成する

この操作は特定のリポジトリの新しいイシューを作成するために使用されます。

イシューを更新する

イシュー番号を指定して、既存のイシューを更新します。

クエリを使用して Github を検索

クエリを使用して Github を検索

テンプレートを使用してリポジトリを作成する (プレビュー)

リポジトリ テンプレートを使用して新しいリポジトリを作成します。 認証済みユーザーは、リポジトリを所有する組織の所有者か、メンバーである必要があります。

プル要求からファイルの一覧を取得する (プレビュー)

この操作は、リポジトリのプル要求からファイルのリストを取得するために使用されます。

プル要求の要求済みレビュー担当者 (プレビュー)

ユーザーおよびチームの指定されたセットからのプル要求をレビューアーに要求します。

プル要求をマージする (プレビュー)

この操作はリポジトリのプル要求をマージするために使用します。

プル要求を作成する (プレビュー)

この操作はリポジトリにプル要求を作成します。 公開リポジトリでプル要求のオープンまたは更新を行うには、ヘッドやソースのブランチに対する書き込みアクセス許可が必要です。 組織が所有するリポジトリの場合、プル要求を作成するには、リポジトリを所有する組織のメンバーである必要があります。

プル要求を取得する (プレビュー)

この操作はリポジトリのプル要求を取得するために使用します。

プル要求を更新する (プレビュー)

この操作はリポジトリのプル要求を更新するために使用します。 公開リポジトリでプル要求の更新を行うには、ヘッドやソースのブランチに対する書き込みアクセス許可が必要です。 組織が所有するリポジトリの場合、プル要求のオープンや更新を行うには、リポジトリを所有する組織のメンバーである必要があります。

マイルストーンを更新する

既存のマイルストーンを更新します。

ユーザーがリポジトリ コラボレーターかどうかをチェックする

ユーザーがリポジトリ コラボレーターかどうかをチェックします。

ユーザーのすべての公開リポジトリを一覧で表示する

ユーザーのすべての公開リポジトリを一覧で表示します。

リポジトリ コラボレーターの一覧

リポジトリ コラボレーターの一覧です。

リポジトリ シークレットを作成または更新する (プレビュー)

暗号化した値でリポジトリ シークレットを作成または更新します。 LibSodium を使用してシークレットを暗号化します。

リポジトリ ディスパッチ イベントを作成する (プレビュー)

GitHub の外部で発生する活動で GitHub アクション ワークフローや GitHub App Webhook をトリガーするときに、この操作は repository_dispatch と呼ばれる Webhook イベントをトリガーします。 repository_dispatch イベントが発生したら GitHub アクション ワークフローや GitHub アプリを実行するように構成する必要があります。

リポジトリのすべてのイシューを取得する

リポジトリのすべてのイシューを取得します。

リポジトリのすべてのプル要求を取得

リポジトリのすべてのプル要求を取得します。

リポジトリのすべてのマイルストーンを一覧で表示します

リポジトリのすべてのマイルストーンを一覧で表示します。

リポジトリのすべてのラベルを一覧表示する

リポジトリのすべてのラベルを一覧で表示します。

リポジトリの公開キーを取得する (プレビュー)

シークレットの暗号化に必要な公開鍵を取得します。 シークレットの作成や更新の前にシークレットを暗号化する必要があります。

リポジトリの特定のイシューを取得する

リポジトリの特定のイシューを取得します。

参照のプレビューを取得する (プレビュー)

Git データベースから単一の参照を返します。 reference パラメーターは、ブランチに対しては heads/<branch name>、タグに対しては tags/<tag name> のようにフォーマットする必要があります。 reference が既存の参照と一致しない場合は 404 が返されます。

参照を作成する (プレビュー)

リポジトリの参照を作成します。 使用中のコミット SHA-1 ハッシュが存在する場合でも、空のリポジトリに対して新しい参照を作成できません。 空のリポジトリとはブランチを持たないリポジトリです。

状態とキーワードでイシューを検索する

状態とキーワードでイシューを検索します。

組織のすべての公開リポジトリを一覧で表示する

組織のすべての公開リポジトリを一覧で表示します。

認証されたユーザーのすべてのリポジトリを一覧で表示する

認証されたユーザーのすべてのリポジトリ (公開および非公開) を一覧で表示します。

認証されたユーザーを取得

認証されたユーザーを取得します。

選択したリポジトリを組織のシークレットから削除する (プレビュー)

リポジトリ アクセスの visibilityselected に設定されている場合、組織のシークレットからリポジトリを削除します。 この表示は、組織のシークレットを作成または更新する ときに設定されます。 このエンドポイントを使用するには admin:org スコープを持つアクセス トークンを使用して認証を行う必要があります。 このエンドポイントを使用するには、GitHub アプリに secrets の組織のアクセス許可がある必要があります。

選択したリポジトリを組織のシークレットに追加します (プレビュー)

リポジトリ アクセスの visibilityselected に設定するとき、リポジトリを組織のシークレットに追加します。 この表示は、組織のシークレットを作成または更新する ときに設定されます。 このエンドポイントを使用するには admin:org スコープを持つアクセス トークンを使用して認証を行う必要があります。 このエンドポイントを使用するには、GitHub アプリに secrets の組織のアクセス許可がある必要があります。

2 つのコミットを比較する (プレビュー)

basehead の両方が repositoryName 内でブランチ名である必要があります。 repositoryName として同じネットワークの他のリポジトリの間でブランチを比較するには、形式 <USERNAME>:branch を使用します。 応答は git log base..head の実行と同様ですが、コミットは時系列で返されます。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

ベース
base True string

ベース パラメーター

ヘッド
head True string

ヘッド パラメーター

戻り値

コミットの比較

本文​​
CommitComparison

GitHub Webhook を削除する (プレビュー)

GitHub Webhook を削除する

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

GitHub Webhook ID
webhookId True string

GitHub Webhook の ID

ID でリポジトリを取得する (プレビュー)

ID でリポジトリを取得します。

パラメーター

名前 キー 必須 説明
リポジトリ ID
repositoryId True integer

リポジトリの一意識別子。

戻り値

Git リポジトリ

本文​​
RepositoryDetails

pull request から要求済みレビュー担当者を削除する (プレビュー)

プル要求で要求されたレビューアーを、指定されたユーザーやチームから削除します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

レビュー担当者
reviewers array of string
team_reviewers
team_reviewers array of string

イシューに割り当て可能な担当者をリポジトリから一覧で表示する

イシューに割り当て可能な担当者をリポジトリから一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

イシューのすべてのラベルを一覧表示する

イシューのすべてのラベルを一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

イシュー番号
issueNumber True integer

指定されたイシューのイシュー番号です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

イシューを作成する

この操作は特定のリポジトリの新しいイシューを作成するために使用されます。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

敬称
title True string

イシューの概要です。

本文​​
body string

イシューの説明です。

戻り値

GitHub イシューのプロパティ。

本文​​
IssueDetailsModel

イシューを更新する

イシュー番号を指定して、既存のイシューを更新します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

イシュー番号
issueNumber True integer

指定されたイシューのイシュー番号です。

肩書き
title string

イシューの概要です。

Body
body string

号の説明です。

assignee
assignee string

イシューの担当者です。

状態
state string

問題のオープンまたはクローズの状態。 オープンまたはクローズのいずれかを指定できます。

ChangeReason
state_reason string

状態の変更理由です。

マイルストーン
milestone string

イシューに関連付けるマイルストーンの数です。

labels
labels array of string

イシューに関連付けるラベルです。

担当者
assignees array of string

イシューに割り当てる UserSnames です。

戻り値

GitHub イシューのプロパティ。

クエリを使用して Github を検索

クエリを使用して Github を検索

パラメーター

名前 キー 必須 説明
query
query string

query

テンプレートを使用してリポジトリを作成する (プレビュー)

リポジトリ テンプレートを使用して新しいリポジトリを作成します。 認証済みユーザーは、リポジトリを所有する組織の所有者か、メンバーである必要があります。

パラメーター

名前 キー 必須 説明
テンプレートの所有者
templateOwner True string

テンプレート リポジトリの所有者名。

テンプレート リポジトリ
templateRepository True string

テンプレート リポジトリの名前。

担当者
owner string

新しいリポジトリを所有する組織や個人。 空白のままにすると認証済みユーザーが所有者になります。

件名
name True string

新しいリポジトリの名前。

内容
description string

新しいリポジトリの簡単な説明。

非公開である
private boolean

新しい非公開リポジトリを作成する場合は true、新しいパブリック リポジトリを作成する場合は false を指定します。

戻り値

Git リポジトリ

本文​​
RepositoryDetails

プル要求からファイルの一覧を取得する (プレビュー)

この操作は、リポジトリのプル要求からファイルのリストを取得するために使用されます。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

戻り値

プル要求の要求済みレビュー担当者 (プレビュー)

ユーザーおよびチームの指定されたセットからのプル要求をレビューアーに要求します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

レビュー担当者
reviewers array of string
team_reviewers
team_reviewers array of string

プル要求をマージする (プレビュー)

この操作はリポジトリのプル要求をマージするために使用します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

コミット タイトル
commitTitle string

自動コミット メッセージのタイトル。

コミット メッセージ
commitMessage string

自動コミット メッセージにアペンドする追加詳細。

Sha
sha string

要求ヘッドをプルする SHA は許可マージと一致する必要があります。

マージ方法
mergeMethod string

使用するマージ方法。 可能な値は、mergesquash、または rebase です。 既定はmergeです。

戻り値

プル要求のマージ結果。

プル要求を作成する (プレビュー)

この操作はリポジトリにプル要求を作成します。 公開リポジトリでプル要求のオープンまたは更新を行うには、ヘッドやソースのブランチに対する書き込みアクセス許可が必要です。 組織が所有するリポジトリの場合、プル要求を作成するには、リポジトリを所有する組織のメンバーである必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

敬称
title string

新しいプル要求のタイトル。

ヘッド
head True string

変更が実装されているブランチの名前。 同じネットワークにあるクロス リポジトリのプル要求の場合、名前空間 head は、次のようなユーザーを使用します: username:branch

ベース
base True string

変更を取り込む先のブランチの名前。 これは、現在のリポジトリの既存のブランチである必要があります。 別のリポジトリのベースにマージを要求する 1 つのリポジトリにプル要求を送信することはできません。

本文​​
body string

プル要求の内容。

メンテナンス担当者を変更できますか?
maintainer_can_modify boolean

メンテナンス担当者がプル要求を変更できるかどうかを示します。

下書きです
draft boolean

プル要求が下書きかどうかを示します。

戻り値

プル要求を使用すると、GitHub のリポジトリにプッシュした変更について他のユーザーに通知できます。 プル要求を送信すると、関心を持つユーザーが一連の変更を確認して、潜在的な変更を議論し、必要に応じてフォローアップ コミットをプッシュできます。

本文​​
PullRequest

プル要求を取得する (プレビュー)

この操作はリポジトリのプル要求を取得するために使用します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

戻り値

プル要求を使用すると、GitHub のリポジトリにプッシュした変更について他のユーザーに通知できます。 プル要求を送信すると、関心を持つユーザーが一連の変更を確認して、潜在的な変更を議論し、必要に応じてフォローアップ コミットをプッシュできます。

本文​​
PullRequest

プル要求を更新する (プレビュー)

この操作はリポジトリのプル要求を更新するために使用します。 公開リポジトリでプル要求の更新を行うには、ヘッドやソースのブランチに対する書き込みアクセス許可が必要です。 組織が所有するリポジトリの場合、プル要求のオープンや更新を行うには、リポジトリを所有する組織のメンバーである必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

プル番号
pullNumber True integer

プル番号。

敬称
title string

プル要求のタイトル。

本文​​
body string

プル要求の内容。

完了状態
state string

このプル要求の状態。 open または closed のいずれかです。

ベース
base string

変更を取り込む先のブランチの名前。 これは、現在のリポジトリの既存のブランチである必要があります。 別のリポジトリを指すようにプル要求に対してベース ブランチを更新できません。

メンテナンス担当者を変更できますか?
maintainer_can_modify boolean

メンテナンス担当者がプル要求を変更できるかどうかを示します。

戻り値

プル要求を使用すると、GitHub のリポジトリにプッシュした変更について他のユーザーに通知できます。 プル要求を送信すると、関心を持つユーザーが一連の変更を確認して、潜在的な変更を議論し、必要に応じてフォローアップ コミットをプッシュできます。

本文​​
PullRequest

マイルストーンを更新する

既存のマイルストーンを更新します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

マイルストーンの番号
milestoneNumber True integer

指定されたマイルストーンのマイルストーン番号です。

肩書き
title string

マイルストーンの概要です。

状態
state string

マイルストーンの状態 (オープンまたはクローズ) です。

マイルストーン
description string

マイルストーンの説明。

due_on
due_on string

マイルストーンの期日です。

戻り値

関連する問題とプル要求のコレクション。

返答
Milestone

ユーザーがリポジトリ コラボレーターかどうかをチェックする

ユーザーがリポジトリ コラボレーターかどうかをチェックします。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

ユーザー名
userName True string

GitHub ユーザー アカウントのハンドルです。

戻り値

API 応答を 1 つだけ取得するモデル

返答
object

ユーザーのすべての公開リポジトリを一覧で表示する

ユーザーのすべての公開リポジトリを一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

タイプ
type string

結果を指定の種類のリポジトリに制限します。

並べ替え
sort string

結果を並べ替えるプロパティです。

direction
direction string

並べ替えの方向です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

取り込むページ番号

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリ コラボレーターの一覧

リポジトリ コラボレーターの一覧です。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリ シークレットを作成または更新する (プレビュー)

暗号化した値でリポジトリ シークレットを作成または更新します。 LibSodium を使用してシークレットを暗号化します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

シークレット名
secretName True string

シークレットの名前。

encrypted_value
encrypted_value string

シークレットの値で、「リポジトリの公開キーを取得する」アクションで取得した公開キーを使用して LibSodium で暗号化されます。

key_id
key_id string

シークレットの暗号化に使用したキーの ID。

リポジトリ ディスパッチ イベントを作成する (プレビュー)

GitHub の外部で発生する活動で GitHub アクション ワークフローや GitHub App Webhook をトリガーするときに、この操作は repository_dispatch と呼ばれる Webhook イベントをトリガーします。 repository_dispatch イベントが発生したら GitHub アクション ワークフローや GitHub アプリを実行するように構成する必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

Event Name
event_type string

カスタム Webhook イベント名。

イベント ペイロード
client_payload object

操作やワークフローが使用する Webhook イベントに関する追加情報を含む JSON ペイロード。

リポジトリのすべてのイシューを取得する

リポジトリのすべてのイシューを取得します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

マイルストーン
milestone string

マイルストーンでフィルター処理します。

state string

状態別にフィルター。

assignee
assignee string

担当者でフィルター処理します。

作成者
creator string

作成者でフィルター処理します。

言及済み
mentioned string

言及でフィルター処理します。

labels
labels string

ラベル名でフィルター処理します。

並べ替え
sort string

結果を並べ替えるフィールドです。

direction
direction string

並べ替えの方向です。

次の日時以降
since string

指定日以降のイシューでフィルター処理します。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリのすべてのプル要求を取得

リポジトリのすべてのプル要求を取得します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

state string

状態別にフィルター。

ヘッド
head string

ヘッド ユーザーまたは組織でフィルター処理します。

base
base string

ベース ブランチ名でフィルター処理します。

並べ替え
sort string

結果を並べ替える基準です。

direction
direction string

並べ替えの方向です。

perPage
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリのすべてのマイルストーンを一覧で表示します

リポジトリのすべてのマイルストーンを一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

state string

マイルストーンの状態です。

並べ替え
sort string

結果を並べ替える基準です。

direction
direction string

並べ替えの方向です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリのすべてのラベルを一覧表示する

リポジトリのすべてのラベルを一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

表示するページ番号です。

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

リポジトリの公開キーを取得する (プレビュー)

シークレットの暗号化に必要な公開鍵を取得します。 シークレットの作成や更新の前にシークレットを暗号化する必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

戻り値

アクション シークレットの設定に使用する公開キー。

リポジトリの特定のイシューを取得する

リポジトリの特定のイシューを取得します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

イシュー番号
issueNumber True integer

指定されたイシューのイシュー番号です。

戻り値

GitHub イシューのプロパティ。

参照のプレビューを取得する (プレビュー)

Git データベースから単一の参照を返します。 reference パラメーターは、ブランチに対しては heads/<branch name>、タグに対しては tags/<tag name> のようにフォーマットする必要があります。 reference が既存の参照と一致しない場合は 404 が返されます。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

参照
reference True string

URL の参照は、ブランチに対しては 、タグに対しては のようにフォーマットする必要があります。

戻り値

リポジトリ内の Git 参照

本文​​
GitReference

参照を作成する (プレビュー)

リポジトリの参照を作成します。 使用中のコミット SHA-1 ハッシュが存在する場合でも、空のリポジトリに対して新しい参照を作成できません。 空のリポジトリとはブランチを持たないリポジトリです。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

参照
ref True string

完全修飾参照名 (例: refs/heads/master)。 先頭が 'refs' でなくスラッシュが 2 つ以上ない場合は拒否されます。

Sha
sha True string

この参照の SHA1 値。

戻り値

リポジトリ内の Git 参照

本文​​
GitReference

状態とキーワードでイシューを検索する

状態とキーワードでイシューを検索します。

パラメーター

名前 キー 必須 説明
四半期
q True string

キーワードと修飾子で検索します。

並べ替え
sort string

結果を並べ替えるプロパティです。

注文
order string

並べ替えの方向です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

取り込むページ番号

戻り値

検索結果を取得するモデル

組織のすべての公開リポジトリを一覧で表示する

組織のすべての公開リポジトリを一覧で表示します。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

タイプ
type string

結果を指定の種類のリポジトリに制限します。

並べ替え
sort string

結果を並べ替えるプロパティです。

direction
direction string

並べ替えの方向です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

取り込むページ番号

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

認証されたユーザーのすべてのリポジトリを一覧で表示する

認証されたユーザーのすべてのリポジトリ (公開および非公開) を一覧で表示します。

パラメーター

名前 キー 必須 説明
可視性
visibility string

結果を、指定された可視性 (公開/非公開/すべて) のリポジトリに制限します。

所属
affiliation string

所属に基づいて結果を制限します。

次の日時以降
since string

結果を、指定の時間後に更新されたリポジトリに制限します。

before
before string

結果を、指定の時間前の更新済みのリポジトリに制限します。

タイプ
type string

結果を指定の種類のリポジトリに制限します。

並べ替え
sort string

結果を並べ替えるプロパティです。

direction
direction string

並べ替えの方向です。

per_page
per_page integer

ページあたりの結果の数。

page
page integer

取り込むページ番号

戻り値

API 応答リストを取得するモデル

アイテム
MultipleFetchModel

認証されたユーザーを取得

認証されたユーザーを取得します。

戻り値

GitHub ユーザーのプロパティ。

選択したリポジトリを組織のシークレットから削除する (プレビュー)

リポジトリ アクセスの visibilityselected に設定されている場合、組織のシークレットからリポジトリを削除します。 この表示は、組織のシークレットを作成または更新する ときに設定されます。 このエンドポイントを使用するには admin:org スコープを持つアクセス トークンを使用して認証を行う必要があります。 このエンドポイントを使用するには、GitHub アプリに secrets の組織のアクセス許可がある必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ ID
repositoryId True integer

リポジトリの一意識別子。

シークレット名
secretName True string

シークレットの名前。

選択したリポジトリを組織のシークレットに追加します (プレビュー)

リポジトリ アクセスの visibilityselected に設定するとき、リポジトリを組織のシークレットに追加します。 この表示は、組織のシークレットを作成または更新する ときに設定されます。 このエンドポイントを使用するには admin:org スコープを持つアクセス トークンを使用して認証を行う必要があります。 このエンドポイントを使用するには、GitHub アプリに secrets の組織のアクセス許可がある必要があります。

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ ID
repositoryId True integer

リポジトリの一意識別子。

シークレット名
secretName True string

シークレットの名前。

トリガー

プル要求が作成または変更されたとき (プレビュー)

プル要求の GitHub Webhook を作成します

新しいイシューが開かれ、自分に割り当てられたとき

この操作は、イシューが開かれ、ログインしたユーザーに割り当てられたときにトリガーされます。

自分にイシューが割り当てられたとき

この操作は、ログインしたユーザーにイシューが割り当てられたときにトリガーされます。

自分に割り当てられたイシューがクローズしたとき

この操作は、ログインしたユーザーに割り当てられたイシューがクローズしたときにトリガーされます。

プル要求が作成または変更されたとき (プレビュー)

プル要求の GitHub Webhook を作成します

パラメーター

名前 キー 必須 説明
リポジトリ所有者
repositoryOwner True string

リポジトリ所有者の名前。

リポジトリ名
repositoryName True string

リポジトリの名前。

リッスンする Webhook イベント
events True array of string

リッスンする Webhook イベント

戻り値

Webhook プル要求応答です。

新しいイシューが開かれ、自分に割り当てられたとき

この操作は、イシューが開かれ、ログインしたユーザーに割り当てられたときにトリガーされます。

戻り値

GitHub イシューのプロパティ。

本文​​
IssueDetailsModel

自分にイシューが割り当てられたとき

この操作は、ログインしたユーザーにイシューが割り当てられたときにトリガーされます。

戻り値

GitHub イシューのプロパティ。

本文​​
IssueDetailsModel

自分に割り当てられたイシューがクローズしたとき

この操作は、ログインしたユーザーに割り当てられたイシューがクローズしたときにトリガーされます。

戻り値

GitHub イシューのプロパティ。

本文​​
IssueDetailsModel

定義

IssueDetailsModel

GitHub イシューのプロパティ。

名前 パス 説明
敬称
title string

イシューの概要です。

本文​​
body string

イシューの説明です。

assignee
assignee UserDetailsModel

GitHub ユーザーのプロパティ。

ID
number integer

問題を表す一意の ID。

完了状態
state string

イシューの状態。

作成日時
created_at string

yyyy-MM-ddTHH:mm:ss.fffZ (UTC 形式)。

リポジトリ URL
repository_url string

リポジトリへの Web リンク。

MultipleSearchFetchModel

検索結果を取得するモデル

名前 パス 説明
body
body array of GeneralAPIModel

結果の本文

MultipleFetchModel

API 応答リストを取得するモデル

名前 パス 説明
アイテム
GeneralAPIModel

API 応答を 1 つだけ取得するモデル

GeneralAPIModel

API 応答を 1 つだけ取得するモデル

UserDetailsModel

GitHub ユーザーのプロパティ。

名前 パス 説明
ログイン
login string

ユーザー ログイン。

ID
id integer

ユーザー ID。

ノード ID
node_id string

ユーザー ノード ID。

アバターの URL
avatar_url string

ユーザー アバターの URL。

Gravatar ID
gravatar_id string

ユーザー Gravatar の ID。

URL
url string

ユーザー URL。

HTML URL
html_url string

ユーザー HTML URL。

フォロワー URL
followers_url string

ユーザー FollowersUrl

フォロー URL
following_url string

ユーザー フォロー URL。

Gists URL
gists_url string

ユーザー Gists URL。

スター付き URL
starred_url string

ユーザー スター付き URL。

サブスクリプション URL
subscriptions_url string

ユーザー サブスクリプション URL。

組織の URL
organizations_url string

ユーザー組織の URL。

Repos URL
repos_url string

ユーザー Repos の URL。

イベント URL
events_url string

ユーザー イベント URL。

受信した イベント URL
received_events_url string

ユーザーが受信した イベント URL。

タイプ
type string

ユーザーの種類。

サイト管理者
site_admin boolean

ユーザーはサイトの管理者ですか?

件名
name string

ユーザー名。

会社
company string

ユーザーの会社。

ブログ
blog string

ユーザーのブログ。

場所
location string

ユーザーの場所。

電子メール
email string

ユーザー メール。

採用可能
hireable boolean

ユーザーは採用可能ですか?

経歴
bio string

ユーザー経歴。

公開 Repos
public_repos integer

ユーザー公開 Repos。

公開 Gists
public_gists integer

ユーザー公開 Gists。

フォロワー
followers integer

ユーザーのフォロワー。

フォロー
following integer

フォローしているユーザー。

作成場所
created_at date-time

ユーザー作成場所。

更新場所
updated_at date-time

ユーザー更新場所。

検証

名前 パス 説明
検証済みである
verified boolean

このコミットの署名を検証すると GitHub が判断するかどうかを示します。

検証の理由
reason string

検証された値の理由。

署名済みの値
payload string

署名済みの値。

コミットの署名
signature string

コミットから抽出した署名。

GitUser

Git の作成者/コミッター情報のメタプロパティ。

名前 パス 説明
Git ユーザー名
name string

ユーザー名

Git ユーザーの電子メール
email string

電子メール

コミットのタイムスタンプ
date string

コミットのタイムスタンプ。

DiffEntry

差分エントリ

名前 パス 説明
ファイル名
filename string

変更されたファイル名。

追加
additions integer

ファイル内の追加回数

削除
deletions integer

ファイル内の削除回数

変更
changes integer

ファイル内の変更回数

ステータス
status string

変更の状態 例: 変更済み、名前を変更済みなど

生の URL
raw_url string

ファイルへの生 URL リンク

Blob URL
blob_url string

ファイルへの Blob URL リンク

PATCH
patch string

ファイルに加えた実際の変更。

変更の SHA
sha string

変更の SHA。

コンテンツ URL
contents_url string

ファイル コンテンツ URL。

前のファイル名
previous_filename string

ファイル名が変更された場合の前のファイル名

コミット

コミット

名前 パス 説明
URL のコミット
url string

コミットの HTTP URL。

Sha のコミット
sha string

コミットの SHA

ノード ID
node_id string

コミットのノード ID。

HTML URL
html_url string

コミットの HTML URL

コメント URL
comments_url string

コミットのコメント URL

URL のコミット
commit.url string

コミットの URL。

作成者
commit.author GitUser

Git の作成者/コミッター情報のメタプロパティ。

コミッター
commit.committer GitUser

Git の作成者/コミッター情報のメタプロパティ。

コミット メッセージ
commit.message string

コミット メッセージ。

コメント数
commit.comment_count integer

コミットのコメント数

Sha のコミット
commit.tree.sha string

コミットの SHA

URL のコミット
commit.tree.url uri

URL のコミット。

確認
commit.verification Verification
作成者
author UserDetailsModel

GitHub ユーザーのプロパティ。

コミッター
committer UserDetailsModel

GitHub ユーザーのプロパティ。

parents array of object
親 Sha
parents.sha string

親ブランチ コミット Sha

親ブランチ URL
parents.url string

親ブランチの URL。

親ブランチ HTML URL
parents.html_url string

親ブランチの HTML URL。

追加
stats.additions integer

追加回数

削除
stats.deletions integer

削除回数

合計
stats.total integer

合計変更回数

ファイル
files array of DiffEntry

CommitComparison

コミットの比較

名前 パス 説明
URL
url string

比較する URL

HTML URL
html_url string

比較する HTML URL

永続的な URL
permalink_url string

比較する永続的な URL

差分 URL
diff_url string

差分 URL

修正プログラムの URL
patch_url string

修正プログラムの URL

base_commit
base_commit Commit

コミット

merge_base_commit
merge_base_commit Commit

コミット

ステータス
status string

比較の状態 例: diverged など

だけ先
ahead_by integer

ベース ブランチだけ先

だけ後
behind_by integer

behind_by ベース ブランチ

合計コミット数
total_commits integer

合計コミット数

コミット
commits array of Commit

コミット

ファイル
files array of DiffEntry

ファイル

ActionsPublicKey

アクション シークレットの設定に使用する公開キー。

名前 パス 説明
キー ID
key_id string

キーの識別子。

キー
key string

Base64 でエンコードした公開キー。

ID
id integer

キーの一意識別子。

URL
url string

公開キーの URL。

敬称
title string

公開キーのタイトル。

作成場所
created_at string

キーの作成日時。

LicenseDetails

ライセンスの詳細

名前 パス 説明
キー
key string

小文字で表したライセンスの SPDX ID。

件名
name string

https://spdx.org/licenses で指定されたライセンスの完全な名前。

URL
url uri

https://choosealicense.com でのライセンスへの URL。

SPDX ID
spdx_id string

https://spdx.org/licenses で指定された短い識別子。

ノード ID
node_id string

ライセンス ノード ID。

HTML URL
html_url uri

ライセンス HTML URL。

RepositoryMiniDetails

Git リポジトリ

名前 パス 説明
リポジトリ ID
id integer

リポジトリの一意識別子。

リポジトリのノード ID
node_id string

このリポジトリのノード ID。

リポジトリ名
name string

リポジトリの名前。

リポジトリの完全な名前
full_name string

このリポジトリの完全な名前。

管理
permissions.admin boolean
pull
permissions.pull boolean
トリアージ
permissions.triage boolean
プッシュ
permissions.push boolean
管理
permissions.maintain boolean
所有者
owner UserDetailsModel

GitHub ユーザーのプロパティ。

リポジトリは非公開ですか?
private boolean

リポジトリが公開済みか非公開か。

リポジトリの説明
description string

このリポジトリの説明

リポジトリのホームページ
homepage uri

このリポジトリのホームページ

リポジトリの言語
language string

このリポジトリの言語

リポジトリはアーカイブ済みですか?
archived boolean

リポジトリがアーカイブ済みかどうか。

リポジトリは無効ですか?
disabled boolean

このリポジトリが無効かどうかを返します。

リポジトリの可視性
visibility string

リポジトリの可視性: 公開、非公開、内部のみ。

リポジトリの作成日
created_at date-time

このリポジトリの作成日時。

リポジトリの更新日
updated_at date-time

このリポジトリの最終更新日時。

レポジトリのリベース マージ許可
allow_rebase_merge boolean

プル要求のリベース マージを許可するかどうか。

リポジトリのスクワッシュ マージ許可
allow_squash_merge boolean

プル要求のスクワシュ マージを許可するかどうか。

リポジトリのマージ時のブランチ削除
delete_branch_on_merge boolean

プル要求のマージ時にヘッド ブランチを削除するかどうか

リポジトリのマージ コミット許可
allow_merge_commit boolean

プル要求に対してマージ コミットを許可するかどうか。

リポジトリのマスター ブランチ
master_branch string

リポジトリのマスター ブランチ。

RepositoryDetails

Git リポジトリ

名前 パス 説明
ID
id integer

リポジトリの一意識別子。

ノード ID
node_id string

このリポジトリのノード ID。

件名
name string

リポジトリの名前。

氏名
full_name string

このリポジトリの完全な名前。

ライセンス
license LicenseDetails

ライセンスの詳細

フォーク
forks integer

このレポジトリのフォーク数。

管理
permissions.admin boolean
pull
permissions.pull boolean
トリアージ
permissions.triage boolean
プッシュ
permissions.push boolean
管理
permissions.maintain boolean
所有者
owner UserDetailsModel

GitHub ユーザーのプロパティ。

非公開である
private boolean

リポジトリが公開済みか非公開か。

HTML URL
html_url uri

このリポジトリの HTML URL

内容
description string

このリポジトリの説明

フォークかどうか
fork boolean

リポジトリがフォークの場合

URL
url uri

このリポジトリの HTTP URL

アーカイブ URL
archive_url string

このリポジトリのアーカイブ URL

担当者 URL
assignees_url string

このリポジトリの担当者 URL

Blob URL
blobs_url string

このリポジトリの Blob URL

ブランチ URL
branches_url string

このリポジトリのブランチ URL

コラボレーター URL
collaborators_url string

このリポジトリのコラボレーター URL

コメント URL
comments_url string

このリポジトリのコメント URL

コミット URL
commits_url string

このリポジトリのコミット URL

比較 URL
compare_url string

このリポジトリの比較 URL

コンテンツ URL
contents_url string

このリポジトリのコンテンツ URL

投稿者 URL
contributors_url uri

このリポジトリの投稿者 URL

展開 URL
deployments_url uri

このリポジトリの展開 URL

ダウンロード URL
downloads_url uri

このリポジトリのダウンロード URL

イベント URL
events_url uri

このリポジトリのイベント URL

フォーク URL
forks_url uri

このリポジトリのフォーク URL

Git コミット URL
git_commits_url string

このリポジトリの Git コミット URL

Git 参照 URL
git_refs_url string

このリポジトリの Git 参照 URL

Git タグ URL
git_tags_url string

このリポジトリの Git タグ URL

Git URL
git_url string

このリポジトリの Git URL

問題コメント URL
issue_comment_url string

このリポジトリの問題コメント URL

問題イベント URL
issue_events_url string

このリポジトリの問題イベント URL

問題 URL
issues_url string

このリポジトリの問題 URL

キー URL
keys_url string

このリポジトリのキー URL

ラベル URL
labels_url string

このリポジトリのラベル URL

言語 URL
languages_url uri

このリポジトリの言語 URL

URL をマージする
merges_url uri

このリポジトリのマージ URL

マイルストーン URL
milestones_url string

このリポジトリのマイルストーン URL

通知 URL
notifications_url string

このリポジトリの通知 URL

プル URL
pulls_url string

このリポジトリのプル URL

リリース URL
releases_url string

このリポジトリのリリース URL

SSH URL
ssh_url string

このリポジトリをクローンする SSH URL

Stargazers URL
stargazers_url uri

このリポジトリの Stargazers の URL (Stargazers は GitHub リポジトリをブックマークに登録した人です)

状態 URL
statuses_url string

このリポジトリの状態 URL

サブスクライバー URL
subscribers_url uri

このリポジトリのサブスクライバー URL

サブスクリプション URL
subscription_url uri

このリポジトリのサブスクリプション URL

タグ URL
tags_url uri

このリポジトリのタグ URL

Teams URL
teams_url uri

このリポジトリの Teams URL

ツリー URL
trees_url string

このリポジトリのツリー URL

クローン URL
clone_url string

このリポジトリのクローン URL

ミラー URL
mirror_url uri

このリポジトリの元のミラー URL

フック URL
hooks_url uri

このリポジトリのフック URL

SVN URL
svn_url uri

このリポジトリの SVN URL

ホームページ
homepage uri

このリポジトリのホームページ

言語
language string

このリポジトリの言語

フォークの数
forks_count integer

このリポジトリに存在するネットワーク全体でのフォーク数。

Stargazers 数
stargazers_count integer

このリポジトリにスターを付けたユーザー数。

ウォッチャー数
watchers_count integer

このリポジトリを表示しているユーザー数。

サイズ
size integer

リポジトリのサイズ

既定ブランチ
default_branch string

このリポジトリの既定ブランチ。

オープン状態の問題件数
open_issues_count integer

このリポジトリに存在するオープン状態の問題件数。

テンプレートかどうか
is_template boolean

新しいリポジトリの生成に使用できるテンプレートとして、このリポジトリが機能するかどうか。

トピック
topics array of string

リポジトリにあるトピックの一覧

問題があるかどうか
has_issues boolean

問題が有効かどうか。

プロジェクトがあるかどうか
has_projects boolean

プロジェクトが有効かどうか。

Wiki があるかどうか
has_wiki boolean

Wiki が有効かどうか。

ページがあるかどうか
has_pages boolean

ページが有効かどうか。

ダウンロード済みかどうか
has_downloads boolean

ダウンロードが有効かどうか。

アーカイブ済みかどうか
archived boolean

リポジトリがアーカイブ済みかどうか。

無効かどうか
disabled boolean

このリポジトリが無効かどうかを返します。

可視性
visibility string

リポジトリの可視性: 公開、非公開、内部のみ。

プッシュした場所
pushed_at date-time

このリポジトリを最後にプッシュした日時。

作成場所
created_at date-time

このリポジトリの作成日時。

更新場所
updated_at date-time

このリポジトリの最終更新日時。

リベース マージを許可する
allow_rebase_merge boolean

プル要求のリベース マージを許可するかどうか。

テンプレート リポジトリ ID
template_repository.id integer

リポジトリの一意識別子。

テンプレート リポジトリのノード ID
template_repository.node_id string

このリポジトリのノード ID。

テンプレート リポジトリの名前
template_repository.name string

リポジトリの名前。

テンプレート リポジトリの完全な名前
template_repository.full_name string

このリポジトリの完全な名前。

所有者
template_repository.owner UserDetailsModel

GitHub ユーザーのプロパティ。

テンプレート リポジトリが非公開かどうか
template_repository.private boolean

リポジトリが公開済みか非公開か。

テンプレート リポジトリの HTML URL
template_repository.html_url uri

このリポジトリの HTML URL

テンプレート リポジトリの説明
template_repository.description string

このリポジトリの説明

テンプレート リポジトリがフォークかどうか
template_repository.fork boolean

リポジトリがフォークの場合

テンプレート リポジトリの URL
template_repository.url uri

このリポジトリの HTTP URL

テンプレート リポジトリのアーカイブ URL
template_repository.archive_url string

このリポジトリのアーカイブ URL

テンプレート リポジトリの担当者 URL
template_repository.assignees_url string

このリポジトリの担当者 URL

テンプレート リポジトリの Blob URL
template_repository.blobs_url string

このリポジトリの Blob URL

テンプレート リポジトリのブランチ URL
template_repository.branches_url string

このリポジトリのブランチ URL

テンプレート リポジトリのコラボレーター URL
template_repository.collaborators_url string

このリポジトリのコラボレーター URL

テンプレート リポジトリのコメント URL
template_repository.comments_url string

このリポジトリのコメント URL

テンプレート リポジトリのコミット URL
template_repository.commits_url string

このリポジトリのコミット URL

テンプレート リポジトリの比較 URL
template_repository.compare_url string

このリポジトリの比較 URL

テンプレート リポジトリのコンテンツ URL
template_repository.contents_url string

このリポジトリのコンテンツ URL

テンプレート リポジトリの投稿者 URL
template_repository.contributors_url uri

このリポジトリの投稿者 URL

テンプレート リポジトリの展開 URL
template_repository.deployments_url uri

このリポジトリの展開 URL

テンプレート リポジトリのダウンロード URL
template_repository.downloads_url uri

このリポジトリのダウンロード URL

テンプレート リポジトリのイベント URL
template_repository.events_url uri

このリポジトリのイベント URL

テンプレート リポジトリのフォーク URL
template_repository.forks_url uri

このリポジトリのフォーク URL

テンプレート リポジトリの Git コミット URL
template_repository.git_commits_url string

このリポジトリの Git コミット URL

テンプレート リポジトリの Git 参照 URL
template_repository.git_refs_url string

このリポジトリの Git 参照 URL

テンプレート リポジトリの Git タグ URL
template_repository.git_tags_url string

このリポジトリの Git タグ URL

テンプレート リポジトリの Git URL
template_repository.git_url string

このリポジトリの Git URL

テンプレート リポジトリの問題コメント URL
template_repository.issue_comment_url string

このリポジトリの問題コメント URL

テンプレート リポジトリの問題イベント URL
template_repository.issue_events_url string

このリポジトリの問題イベント URL

テンプレート リポジトリの問題 URL
template_repository.issues_url string

このリポジトリの問題 URL

テンプレート リポジトリのキー URL
template_repository.keys_url string

このリポジトリのキー URL

テンプレート リポジトリのラベル URL
template_repository.labels_url string

このリポジトリのラベル URL

テンプレート リポジトリの言語 URL
template_repository.languages_url uri

このリポジトリの言語 URL

テンプレート リポジトリのマージ URL
template_repository.merges_url uri

このリポジトリのマージ URL

テンプレート リポジトリのマイルストーン URL
template_repository.milestones_url string

このリポジトリのマイルストーン URL

テンプレート リポジトリの通知 URL
template_repository.notifications_url string

このリポジトリの通知 URL

テンプレート リポジトリのプル URL
template_repository.pulls_url string

このリポジトリのプル URL

テンプレート リポジトリのリリース URL
template_repository.releases_url string

このリポジトリのリリース URL

テンプレート リポジトリの SSH URL
template_repository.ssh_url string

このリポジトリをクローンする SSH URL

テンプレート リポジトリの Stargazers URL
template_repository.stargazers_url uri

このリポジトリの Stargazers の URL (Stargazers は GitHub リポジトリをブックマークに登録した人です)

テンプレート リポジトリの状態 URL
template_repository.statuses_url string

このリポジトリの状態 URL

テンプレート リポジトリのサブスクライバー URL
template_repository.subscribers_url uri

このリポジトリのサブスクライバー URL

テンプレート リポジトリのサブスクリプション URL
template_repository.subscription_url uri

このリポジトリのサブスクリプション URL

テンプレート リポジトリのタグ URL
template_repository.tags_url uri

このリポジトリのタグ URL

テンプレート リポジトリの Teams URL
template_repository.teams_url uri

このリポジトリの Teams URL

テンプレート リポジトリのツリー URL
template_repository.trees_url string

このリポジトリのツリー URL

テンプレート リポジトリのクローン URL
template_repository.clone_url string

このリポジトリのクローン URL

テンプレート リポジトリのミラー URL
template_repository.mirror_url uri

このリポジトリの元のミラー URL

テンプレート リポジトリのフック URL
template_repository.hooks_url uri

このリポジトリのフック URL

テンプレート リポジトリの SVN URL
template_repository.svn_url uri

このリポジトリの SVN URL

テンプレート リポジトリのホームページ
template_repository.homepage uri

このリポジトリのホームページ

テンプレート リポジトリの言語
template_repository.language string

このリポジトリの言語

テンプレート リポジトリのフォーク数
template_repository.forks_count integer

このリポジトリに存在するネットワーク全体でのフォーク数。

テンプレート リポジトリの Stargazers 数
template_repository.stargazers_count integer

このリポジトリにスターを付けたユーザー数。

テンプレート リポジトリのウォッチャー数
template_repository.watchers_count integer

このリポジトリを表示しているユーザー数。

テンプレート リポジトリのサイズ
template_repository.size integer

リポジトリのサイズ

テンプレート リポジトリの既定ブランチ
template_repository.default_branch string

このリポジトリの既定ブランチ。

テンプレート リポジトリのオープン状態の問題件数
template_repository.open_issues_count integer

このリポジトリに存在するオープン状態の問題件数。

テンプレート リポジトリがテンプレートかどうか
template_repository.is_template boolean

新しいリポジトリの生成に使用できるテンプレートとして、このリポジトリが機能するかどうか。

テンプレート リポジトリのトピック
template_repository.topics array of string

リポジトリにあるトピックの一覧

テンプレート リポジトリに問題があるかどうか
template_repository.has_issues boolean

問題が有効かどうか。

テンプレート リポジトリにプロジェクトがあるかどうか
template_repository.has_projects boolean

プロジェクトが有効かどうか。

テンプレート リポジトリに Wiki があるかどうか
template_repository.has_wiki boolean

Wiki が有効かどうか。

テンプレート リポジトリにページがあるかどうか
template_repository.has_pages boolean

ページが有効かどうか。

テンプレート リポジトリにダウンロードがあるかどうか
template_repository.has_downloads boolean

ダウンロードが有効かどうか。

テンプレート リポジトリがアーカイブ済みかどうか
template_repository.archived boolean

リポジトリがアーカイブ済みかどうか。

テンプレート リポジトリが無効かどうか
template_repository.disabled boolean

このリポジトリが無効かどうかを返します。

テンプレート リポジトリの可視性
template_repository.visibility string

リポジトリの可視性: 公開、非公開、内部のみ。

テンプレート リポジトリをプッシュした場所
template_repository.pushed_at date-time

このリポジトリを最後にプッシュした日時。

テンプレート リポジトリの作成場所
template_repository.created_at date-time

このリポジトリの作成日時。

テンプレート リポジトリの更新場所
template_repository.updated_at date-time

このリポジトリの最終更新日時。

管理
template_repository.permissions.admin boolean
プッシュ
template_repository.permissions.push boolean
pull
template_repository.permissions.pull boolean
テンプレート レポジトリのリベース マージ許可
template_repository.allow_rebase_merge boolean

プル要求のリベース マージを許可するかどうか。

テンプレート リポジトリのテンプレート リポジトリ
template_repository.template_repository string

テンプレート リポジトリ。

テンプレート リポジトリの一時的なクローン トークン
template_repository.temp_clone_token string

このリポジトリを複製するための一時的な認証トークン。

テンプレート リポジトリのスクワッシュ マージ許可
template_repository.allow_squash_merge boolean

プル要求のスクワシュ マージを許可するかどうか。

テンプレート リポジトリのマージ時のブランチ削除
template_repository.delete_branch_on_merge boolean

プル要求のマージ時にヘッド ブランチを削除するかどうか

テンプレート リポジトリのマージ コミット許可
template_repository.allow_merge_commit boolean

プル要求に対してマージ コミットを許可するかどうか。

テンプレート リポジトリのサブスクライバー数
template_repository.subscribers_count integer

このリポジトリのサブスクライバー数。

テンプレート リポジトリのネットワーク数
template_repository.network_count integer

リポジトリのネットワーク数

一時的なクローン トークン
temp_clone_token string

このリポジトリを複製するための一時的な認証トークン。

スクワッシュ マージを許可する
allow_squash_merge boolean

プル要求のスクワシュ マージを許可するかどうか。

マージ時にブランチを削除する
delete_branch_on_merge boolean

プル要求のマージ時にヘッド ブランチを削除するかどうか

マージ コミットを許可する
allow_merge_commit boolean

プル要求に対してマージ コミットを許可するかどうか。

サブスクライバー数
subscribers_count integer

このリポジトリのサブスクライバー数。

ネットワーク数
network_count integer

リポジトリのネットワーク数

オープン状態の問題
open_issues integer

リポジトリのオープン状態の問題。

ウォッチャー
watchers integer

リポジトリ ウォッチャー。

マスター ブランチ
master_branch string

リポジトリのマスター ブランチ。

スターを付けた場所
starred_at string

リポジトリにスターを付けた場所

GitReference

リポジトリ内の Git 参照

名前 パス 説明
参照
ref string

完全修飾参照名。

ノード ID
node_id string

参照のノード ID。

URL
url uri

参照の URL。

種類
object.type string

オブジェクトの種類。

Sha
object.sha string

参照の SHA。

URL
object.url uri

オブジェクトの URL。

PullRequestMergeResult

プル要求のマージ結果。

名前 パス 説明
Sha
sha string

マージ コミットの SHA。

マージされていますか?
merged boolean

プル要求をマージしたかどうか。

メッセージ
message string

応答メッセージをマージする。

マイルストーン

関連する問題とプル要求のコレクション。

名前 パス 説明
マイルストーンの URL
url uri

マイルストーンの HTTP URL。

マイルストーンの HTML URL
html_url uri

マイルストーンの HTML URL。

マイルストーンのラベル URL
labels_url uri

マイルストーンのラベル URL。

マイルストーン ID
id integer

マイルストーンの一意識別子。

マイルストーンのノード ID
node_id string

マイルストーンのノード ID。

マイルストーンの番号
number integer

マイルストーンの番号。

マイルストーンの状態
state string

マイルストーンの状態。

マイルストーンのタイトル
title string

マイルストーンのタイトル。

マイルストーンの説明
description string

マイルストーンの説明。

作成者
creator UserDetailsModel

GitHub ユーザーのプロパティ。

マイルストーンのオープン状態の問題
open_issues integer

このリポジトリに対するオープン状態の問題件数。

マイルストーンのクローズ済み問題
closed_issues integer

リポジトリに対するクローズ済みの問題件数。

マイルストーンの作成日
created_at date-time

マイルストーンの作成日時。

マイルストーンの更新日
updated_at date-time

マイルストーンの最終更新日時。

マイルストーンのクローズ日
closed_at date-time

マイルストーンをクローズした日時。

マイルストーンの期日
due_on date-time

マイルストーンの期日。

Label

色分けされたラベルで問題の分類とフィルター処理ができます (Gmail のラベルと同様)。

名前 パス 説明
ID
id integer

ラベルの一意識別子。

ノード ID
node_id string

ラベルのノード ID。

URL
url uri

ラベルの URL

件名
name string

ラベルの名前です。

内容
description string

このラベルの簡単な説明。

color string

先頭の # を除き 6 文字の 16 進数コード、色を識別する

既定かどうか。
default boolean

これが既定のラベルであるかどうか。

TeamDetails

指定したリポジトリにアクセス許可を与える組織メンバーのグループ。

名前 パス 説明
ID
id integer

チームの一意識別子。

ノード ID
node_id string

チームのノード ID。

URL
url uri

チームの URL。

メンバーの URL
members_url string

チーム メンバーの HTTP URL。

name string

チームの名前

内容
description string

チームの説明

アクセス許可
permission string

チームがリポジトリに対して持つアクセス許可

プライバシー​
privacy string

このチームに必要なプライバシー レベル

HTML URL
html_url uri

チームの HTML URL。

リポジトリの URL
repositories_url uri

このチームのリポジトリに対する HTTP URL。

置換フィールド
slug string

チームに対応する置換フィールド。

LDAP DN
ldap_dn string

LDAP 環境でチームがマップされる識別名 (DN)

PullRequest

プル要求を使用すると、GitHub のリポジトリにプッシュした変更について他のユーザーに通知できます。 プル要求を送信すると、関心を持つユーザーが一連の変更を確認して、潜在的な変更を議論し、必要に応じてフォローアップ コミットをプッシュできます。

名前 パス 説明
プル要求 URL
url uri

このプル要求の HTTP URL。

プル要求 ID
id integer

プル要求の一意識別子。

プル要求のノード ID
node_id string

プル要求のノード ID。

プル要求の HTML URL
html_url uri

プル要求の HTML URL。

プル要求の差分 URL
diff_url uri

プル要求の差分 URL。

プル要求の修正プログラム URL
patch_url uri

プル要求の修正プログラム URL。

プル要求の問題 URL
issue_url uri

プル要求の問題 URL。

プル要求のコミット URL
commits_url uri

プル要求のコミット URL。

プル要求のレビュー コメント URL
review_comments_url uri

プル要求のレビュー コメント URL。

プル要求のレビュー コメント URL
review_comment_url string

プル要求のレビュー コメント URL です。

プル要求の差分 URL
comments_url uri

プル要求の差分 URL。

プル要求の状態 URL
statuses_url uri

プル要求の状態 URL。

プル要求番号
number integer

リポジトリにあるプル要求を一意に識別する番号。

プル要求の状態
state string

このプル要求の状態。 open または closed のいずれかです。

プル要求はロック済みですか?
locked boolean

プル要求がロック済みかどうか。

プル要求のタイトル
title string

プル要求のタイトル。

ユーザー
user UserDetailsModel

GitHub ユーザーのプロパティ。

プル要求の本文
body string

マークダウン形式の本文。

プル要求のラベル
labels array of Label

プル要求に関連付けられたラベルの一覧。

milestone Milestone

関連する問題とプル要求のコレクション。

プル要求のアクティブなロックの理由
active_lock_reason string

会話がロックされた理由。

プル要求の作成日
created_at date-time

プル要求の作成日時。

プル要求の更新日
updated_at date-time

プル要求の最終更新日時。

プル要求のクローズ日
closed_at date-time

プル要求のクローズ日時。

プル要求のマージ日
merged_at date-time

プル要求をマージした日時。

プル要求のマージ コミット Sha
merge_commit_sha string

プル要求のマージ コミット Sha。

assignee
assignee UserDetailsModel

GitHub ユーザーのプロパティ。

プル要求の担当者
assignees array of UserDetailsModel

プル要求の担当者一覧。

プル要求の要求済みレビュー担当者
requested_reviewers array of UserDetailsModel

このプル要求に割り当てられたユーザーの一覧。

Pull Request を要求したチーム
requested_teams array of TeamDetails

このプル要求に対して要求したチームの一覧。

プル要求のヘッド ラベル
head.label string

ヘッド ラベル。

プル要求のヘッド参照
head.ref string

ヘッド参照

リポジトリ
head.repo RepositoryMiniDetails

Git リポジトリ

プル要求のヘッド Sha
head.sha string

ヘッド Sha

ユーザー
head.user UserDetailsModel

GitHub ユーザーのプロパティ。

プル要求のベース ラベル
base.label string

ヘッド ラベル。

プル要求のベース参照
base.ref string

ヘッド参照

リポジトリ
base.repo RepositoryMiniDetails

Git リポジトリ

プル要求のベース Sha
base.sha string

ヘッド Sha

ユーザー
base.user UserDetailsModel

GitHub ユーザーのプロパティ。

プル要求作成者の関連付け
author_association string

コメントの件名と作成者の関連付け。

プル要求は下書きですか?
draft boolean

プル要求が下書きであるかどうかを示します。

プル要求はマージ済みですか?
merged boolean

プル要求をマージしたかどうか。

プル要求はマージ可能ですか?
mergeable boolean

マージ競合の有無に基づいてプル要求をマージできるかどうか。

リード要求はリベース可能ですか?
rebaseable boolean

プル要求をリベースできるかどうか。

プル要求のマージ可能状態
mergeable_state string

プル要求のマージ可能状態。

merged_by
merged_by UserDetailsModel

GitHub ユーザーのプロパティ。

プル要求のコメント数
comments integer

このプル要求のコメント数。

プル要求のレビュー コメント数
review_comments integer

このプル要求のレビュー コメント数。

メンテナンス担当者がプル要求を変更できますか?
maintainer_can_modify boolean

メンテナンス担当者がプル要求を変更できるかどうかを示します。

プル要求のコミット回数
commits integer

このプル要求のコミット回数。

プル要求の追加回数
additions integer

このプル要求が含む追加件数。

プル要求の削除回数
deletions integer

このプル要求の削除回数。

プル要求の変更済みファイル数
changed_files integer

このプル要求で変更されたファイル数。

PullRequestFile

名前 パス 説明
ファイルの SHA
sha string

ファイルの SHA です。

ファイル名
filename string

ファイル名です。

ファイルの修正の状態
status string

ファイルの修正の状態です。

ファイルに対して行われた追加の数
additions integer

ファイルに対して行われた追加の数です。

ファイルに対して行われた削除の数
deletions integer

ファイルに対して行われた削除の数です。

ファイルに対して行われた変更の数
changes integer

ファイルに対して行われた変更の数です。

ファイルの Blob URL
blob_url string

ファイルの Blob URLです。

ファイルの未処理の URL
raw_url string

ファイルの未処理の URLです。

ファイルのコンテンツの URL
contents_url string

ファイルのコンテンツの URL です。

ファイルの修正プログラムの内容
patch string

ファイルの修正プログラムの内容です。

WebhookPullRequestResponse

Webhook プル要求応答です。

名前 パス 説明
実行された操作
action string

実行された操作です。

プル要求番号
number integer

プル要求番号です。

pull_request
pull_request PullRequest

プル要求を使用すると、GitHub のリポジトリにプッシュした変更について他のユーザーに通知できます。 プル要求を送信すると、関心を持つユーザーが一連の変更を確認して、潜在的な変更を議論し、必要に応じてフォローアップ コミットをプッシュできます。

オブジェクト

’オブジェクト’ という種類です。