共用方式為


GitHub

GitHub 是一種基於 Web 的 Git 存儲庫託管服務。 它提供 Git 的所有分散式版本控制和原始程式碼管理 (SCM) 功能,並新增自己的功能。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 標準 除下列區域外的所有 Power Automate 區域
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 標準 除下列區域外的所有 Power Apps 區域
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 標準 除下列區域外的所有 Power Automate 區域
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 Microsoft
URL https://support.microsoft.com/
Email abapi@microsoft.com
連接器中繼資料
Publisher Microsoft
網站 https://github.com/
隱私策略 https://github.com/trust-center/privacy
類別 IT運營;通敵

連接器 github 應用程式發行者

此連接器會依 aaptapps 帳戶使用應用程式

連接器深入

有關連接器的更多資訊,請參閱 深入部分

已知問題與限制

請注意,觸發器會在指派給已驗證使用者的擁有和成員存放庫中搜尋問題專案。 不支援組織儲存庫。

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒
觸發輪詢的頻率 1 15 秒

動作

Github MCP 伺服器

Github MCP 伺服器

使用查詢搜尋 Github

使用查詢搜尋 Github

使用範本建立存放庫 (預覽版)

使用儲存庫範本建立新的儲存庫。 已驗證的使用者必須擁有或是擁有儲存庫之組織的成員。

依州和關鍵字尋找問題

依狀態和關鍵字尋找問題。

依識別碼取得存放庫 (預覽版)

依 ID 取得存放庫。

列出使用者的所有公用儲存庫

列出使用者的所有公用儲存庫。

列出問題的所有標籤

列出問題的所有標籤。

列出存放庫中問題的可用受指派人

列出存放庫中問題的可用受指派人。

列出存放庫協作者

列出存放庫協作者。

列出存放庫的所有標籤

列出存放庫的所有標籤。

列出存放庫的所有里程碑

列出存放庫的所有里程碑。

列出已驗證使用者的所有儲存庫

列出已驗證使用者的所有儲存庫 (公用和私人)。

列出組織的所有公用儲存庫

列出組織的所有公用儲存庫。

刪除 GitHub Webhook (預覽版)

刪除 GitHub Webhook

取得儲存庫的所有提取請求

取得存放庫的所有提取請求。

取得參考 (預覽版)

從 Git 資料庫傳回單一參考。 參數reference的格式必須為分支和tags/<tag name>標籤。heads/<branch name> 如果 不 reference 符合現有的參考,則會傳回 a 404

取得存放庫公開金鑰 (預覽版)

取得您的公開金鑰,您需要加密秘密。 您必須先加密密碼,才能建立或更新密碼。

取得存放庫的所有問題

取得存放庫的所有問題。

取得存放庫的特定問題

取得存放庫的特定問題。

取得已驗證的使用者

取得已驗證的使用者。

取得提取要求 (預覽版)

此作業可用來取得存放庫的提取要求。

合併提取要求 (預覽)

此作業可用來合併存放庫的提取要求。

將選取的存放庫新增至組織秘密 (預覽)

當 for 存放庫存取權設定 visibilityselected時,將存放庫新增至組織密碼。 可見度是在 您建立或更新組織密碼時設定的。 您必須使用存取權杖 admin:org 進行驗證,其範圍為使用此端點。 GitHub Apps 必須具有組織權限 secrets 才能使用此端點。

建立參考 (預覽)

建立儲存庫的參考。 您無法為空白儲存庫建立新的參照,即使使用的認可 SHA-1 雜湊存在也一樣。 空儲存庫是沒有分支的儲存庫。

建立問題

此作業可用來為特定儲存庫建立新問題。

建立存放庫分派事件 (預覽版)

此作業是觸發呼叫的 Webhook 事件 repository_dispatch ,當您想要在 GitHub 外部發生的活動觸發 GitHub Actions 工作流程或 GitHub 應用程式 Webhook 時。 您必須設定 GitHub Actions 工作流程或 GitHub 應用程式,才能在事件發生時 repository_dispatch 執行。

建立或更新存放庫密碼 (預覽版)

建立或更新具有加密值的儲存庫密碼。 使用 LibSodium 加密您的秘密。

建立提取要求 (預覽版)

此作業是在存放庫中建立提取請求。 若要在公用存放庫中開啟或更新提取要求,您必須具有前端或來源分支的寫入權限。 對於組織擁有的儲存庫,您必須是擁有儲存庫的組織成員,才能建立提取請求。

從提取要求中移除要求的檢閱者 (預覽)

從一組指定使用者和/或小組的提取要求中移除要求的檢閱者。

從提取要求取得檔案清單 (預覽版)

此作業可用來從存放庫的提取要求取得檔案清單。

從組織秘密中移除選取的存放庫 (預覽)

當 for 存放庫存取權設定 visibilityselected時,從組織密碼中移除存放庫。 可見度是在 您建立或更新組織密碼時設定的。 您必須使用存取權杖 admin:org 進行驗證,其範圍為使用此端點。 GitHub Apps 必須具有組織權限 secrets 才能使用此端點。

更新問題

根據問題編號更新現有問題。

更新提取要求 (預覽版)

此作業可用來更新存放庫的提取要求。 若要更新公用存放庫中的提取要求,您必須具有 head 或來源分支的寫入權限。 對於組織擁有的儲存庫,您必須是擁有儲存庫的組織成員,才能開啟或更新提取請求。

更新里程碑

更新現有的里程碑。

檢查使用者是否為存放庫共同作業者

檢查使用者是否為存放庫協作者。

比較兩個認可 (預覽版)

兩者 和 headbase必須是 中的分支名稱repositoryName。 若要比較與 相同 repositoryName網路中其他儲存庫的分支,請使用 <USERNAME>:branch格式 。 回應等同於執行 git log base..head 命令;不過,認可會依時間順序傳回。

要求提取要求的檢閱者 (預覽版)

要求從一組指定的使用者和/或小組檢閱提取要求。

Github MCP 伺服器

Github MCP 伺服器

使用查詢搜尋 Github

使用查詢搜尋 Github

參數

名稱 機碼 必要 類型 Description
查詢
query string

查詢

使用範本建立存放庫 (預覽版)

使用儲存庫範本建立新的儲存庫。 已驗證的使用者必須擁有或是擁有儲存庫之組織的成員。

參數

名稱 機碼 必要 類型 Description
範本擁有者
templateOwner True string

範本儲存庫擁有者的名稱。

範本儲存庫
templateRepository True string

範本存放庫的名稱。

所有者
owner string

將擁有新儲存庫的組織或個人。 如果留空,則已驗證的使用者將是擁有者。

名稱
name True string

新儲存庫的名稱。

Description
description string

新儲存庫的簡短說明。

是私人的嗎?
private boolean

true建立新的私人儲存庫或false建立新的公用儲存庫。

傳回

git 儲存庫

依州和關鍵字尋找問題

依狀態和關鍵字尋找問題。

參數

名稱 機碼 必要 類型 Description
q
q True string

搜尋關鍵字和限定詞。

排序
sort string

要排序結果的屬性。

順序
order string

排序方向。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要擷取的頁碼

傳回

擷取搜尋結果的模型

依識別碼取得存放庫 (預覽版)

依 ID 取得存放庫。

參數

名稱 機碼 必要 類型 Description
存放庫識別碼
repositoryId True integer

存放庫的唯一識別碼。

傳回

git 儲存庫

列出使用者的所有公用儲存庫

列出使用者的所有公用儲存庫。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

型別
type string

將結果限制為指定類型的儲存庫。

排序
sort string

要排序結果的屬性。

方向
direction string

排序方向。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要擷取的頁碼

傳回

擷取清單 API 回應的模型

列出問題的所有標籤

列出問題的所有標籤。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

發行編號
issueNumber True integer

指定問題的問題編號。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

列出存放庫中問題的可用受指派人

列出存放庫中問題的可用受指派人。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

列出存放庫協作者

列出存放庫協作者。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

列出存放庫的所有標籤

列出存放庫的所有標籤。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

列出存放庫的所有里程碑

列出存放庫的所有里程碑。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

狀態
state string

里程碑的狀態。

排序
sort string

對結果進行排序的依據。

方向
direction string

排序方向。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

列出已驗證使用者的所有儲存庫

列出已驗證使用者的所有儲存庫 (公用和私人)。

參數

名稱 機碼 必要 類型 Description
能見度
visibility string

將結果限制為指定可見度的儲存庫 (public/private/all)。

隸屬關係
affiliation string

根據隸屬關係限制結果。

since string

將結果限制為在指定時間後更新的儲存庫。

before
before string

將結果限制為在指定時間之前更新的儲存庫。

型別
type string

將結果限制為指定類型的儲存庫。

排序
sort string

要排序結果的屬性。

方向
direction string

排序方向。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要擷取的頁碼

傳回

擷取清單 API 回應的模型

列出組織的所有公用儲存庫

列出組織的所有公用儲存庫。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

型別
type string

將結果限制為指定類型的儲存庫。

排序
sort string

要排序結果的屬性。

方向
direction string

排序方向。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要擷取的頁碼

傳回

擷取清單 API 回應的模型

刪除 GitHub Webhook (預覽版)

刪除 GitHub Webhook

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

GitHub Webhook ID
webhookId True string

GitHub Webhook 的識別碼

取得儲存庫的所有提取請求

取得存放庫的所有提取請求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

狀態
state string

依狀態篩選。

頁首
head string

依負責人使用者或組織篩選。

基礎映像
base string

依基底分支名稱篩選。

排序
sort string

對結果進行排序的依據。

方向
direction string

排序方向。

每個頁面
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

取得參考 (預覽版)

從 Git 資料庫傳回單一參考。 參數reference的格式必須為分支和tags/<tag name>標籤。heads/<branch name> 如果 不 reference 符合現有的參考,則會傳回 a 404

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

Reference
reference True string

URL 中的 ref 必須格式化為分支的 heads/<分支名稱> 和標籤的標籤/<標籤名稱> 。

傳回

存放庫內的 Git 參考

身體
GitReference

取得存放庫公開金鑰 (預覽版)

取得您的公開金鑰,您需要加密秘密。 您必須先加密密碼,才能建立或更新密碼。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

傳回

用於設定動作密碼的公開金鑰。

取得存放庫的所有問題

取得存放庫的所有問題。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

里程碑
milestone string

按里程碑過濾。

狀態
state string

依狀態篩選。

受託人
assignee string

依受指派人篩選。

建立者
creator string

按創建者過濾。

提到
mentioned string

按提及過濾。

labels
labels string

依標籤名稱篩選。

排序
sort string

要排序結果的欄位。

方向
direction string

排序方向。

since string

按指定日期之後的問題進行過濾。

per_page
per_page integer

每頁的結果數。

頁面
page integer

要顯示的頁碼。

傳回

擷取清單 API 回應的模型

取得存放庫的特定問題

取得存放庫的特定問題。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

發行編號
issueNumber True integer

指定問題的問題編號。

傳回

GitHub 問題的屬性。

取得已驗證的使用者

取得已驗證的使用者。

傳回

GitHub 使用者的屬性。

取得提取要求 (預覽版)

此作業可用來取得存放庫的提取要求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

傳回

提取請求可讓您告訴其他人您已推送至 GitHub 上存放庫的變更。 發送拉取請求後,感興趣的各方可以查看一組更改,討論潛在的修改,甚至在必要時推送後續提交。

身體
PullRequest

合併提取要求 (預覽)

此作業可用來合併存放庫的提取要求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

認可標題
commitTitle string

自動認可訊息的標題。

認可訊息
commitMessage string

要附加至自動認可訊息的額外詳細資料。

sha string

提取要求頭必須相符的 SHA 才能允許合併。

合併方法
mergeMethod string

Merge 方法。 可能的值為 mergesquashrebase。 預設值為 merge

傳回

提取要求合併結果。

將選取的存放庫新增至組織秘密 (預覽)

當 for 存放庫存取權設定 visibilityselected時,將存放庫新增至組織密碼。 可見度是在 您建立或更新組織密碼時設定的。 您必須使用存取權杖 admin:org 進行驗證,其範圍為使用此端點。 GitHub Apps 必須具有組織權限 secrets 才能使用此端點。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫識別碼
repositoryId True integer

存放庫的唯一識別碼。

秘密名稱
secretName True string

密碼的名稱。

建立參考 (預覽)

建立儲存庫的參考。 您無法為空白儲存庫建立新的參照,即使使用的認可 SHA-1 雜湊存在也一樣。 空儲存庫是沒有分支的儲存庫。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

Reference
ref True string

完整參照的名稱 (即: refs/heads/master)。 如果它不是以 'refs' 開頭並且至少有兩個斜線,它將被拒絕。

sha True string

此參考的 SHA1 值。

傳回

存放庫內的 Git 參考

身體
GitReference

建立問題

此作業可用來為特定儲存庫建立新問題。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

Title
title True string

問題摘要。

身體
body string

問題描述。

傳回

GitHub 問題的屬性。

建立存放庫分派事件 (預覽版)

此作業是觸發呼叫的 Webhook 事件 repository_dispatch ,當您想要在 GitHub 外部發生的活動觸發 GitHub Actions 工作流程或 GitHub 應用程式 Webhook 時。 您必須設定 GitHub Actions 工作流程或 GitHub 應用程式,才能在事件發生時 repository_dispatch 執行。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

事件名稱
event_type string

自訂 Webhook 事件名稱。

事件承載
client_payload object

JSON 承載,其中包含有關您的動作或工作頻可能使用的 Webhook 事件的額外資訊。

建立或更新存放庫密碼 (預覽版)

建立或更新具有加密值的儲存庫密碼。 使用 LibSodium 加密您的秘密。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

秘密名稱
secretName True string

密碼的名稱。

encrypted_value
encrypted_value string

密碼的值,使用從取得存放庫公開金鑰動作擷取的公開金鑰,以 LibSodium 加密。

key_id
key_id string

您用來加密密碼的金鑰 ID。

建立提取要求 (預覽版)

此作業是在存放庫中建立提取請求。 若要在公用存放庫中開啟或更新提取要求,您必須具有前端或來源分支的寫入權限。 對於組織擁有的儲存庫,您必須是擁有儲存庫的組織成員,才能建立提取請求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

Title
title string

新提取要求的標題。

Head
head True string

實作變更的分支名稱。 對於相同網路中的跨存放庫提取要求,命名空間 head 的使用者如下所示: username:branch

Base
base True string

您要提取變更的分支名稱。 這應該是目前存放庫上的現有分支。 您無法將提取要求提交至一個要求合併至另一個存放庫基礎的存放庫。

身體
body string

提取要求的內容。

維護者可以修改嗎?
maintainer_can_modify boolean

指出維護者是否可以修改提取請求。

草稿
draft boolean

指出提取要求是否為草稿。

傳回

提取請求可讓您告訴其他人您已推送至 GitHub 上存放庫的變更。 發送拉取請求後,感興趣的各方可以查看一組更改,討論潛在的修改,甚至在必要時推送後續提交。

身體
PullRequest

從提取要求中移除要求的檢閱者 (預覽)

從一組指定使用者和/或小組的提取要求中移除要求的檢閱者。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

評論家
reviewers array of string
team_reviewers
team_reviewers array of string

從提取要求取得檔案清單 (預覽版)

此作業可用來從存放庫的提取要求取得檔案清單。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

傳回

從組織秘密中移除選取的存放庫 (預覽)

當 for 存放庫存取權設定 visibilityselected時,從組織密碼中移除存放庫。 可見度是在 您建立或更新組織密碼時設定的。 您必須使用存取權杖 admin:org 進行驗證,其範圍為使用此端點。 GitHub Apps 必須具有組織權限 secrets 才能使用此端點。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫識別碼
repositoryId True integer

存放庫的唯一識別碼。

秘密名稱
secretName True string

密碼的名稱。

更新問題

根據問題編號更新現有問題。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

發行編號
issueNumber True integer

指定問題的問題編號。

Title
title string

問題摘要。

身體
body string

問題描述。

受託人
assignee string

問題的受讓人。

State
state string

問題的開啟或關閉狀態。 可以是開放式或封閉式之一。

變更原因
state_reason string

狀態變更的原因。

里程碑
milestone string

要與問題相關聯的里程碑數目。

labels
labels array of string

與問題相關聯的標籤。

受讓人
assignees array of string

UserS名稱指派給問題。

傳回

GitHub 問題的屬性。

更新提取要求 (預覽版)

此作業可用來更新存放庫的提取要求。 若要更新公用存放庫中的提取要求,您必須具有 head 或來源分支的寫入權限。 對於組織擁有的儲存庫,您必須是擁有儲存庫的組織成員,才能開啟或更新提取請求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

Title
title string

提取請求的標題。

身體
body string

提取要求的內容。

State
state string

此提取要求的狀態。 openclosed

Base
base string

您要提取變更的分支名稱。 這應該是目前存放庫上的現有分支。 您無法更新提取要求上的基底分支,以指向另一個存放庫。

維護者可以修改嗎?
maintainer_can_modify boolean

指出維護者是否可以修改提取請求。

傳回

提取請求可讓您告訴其他人您已推送至 GitHub 上存放庫的變更。 發送拉取請求後,感興趣的各方可以查看一組更改,討論潛在的修改,甚至在必要時推送後續提交。

身體
PullRequest

更新里程碑

更新現有的里程碑。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

里程碑編號
milestoneNumber True integer

指定里程碑的里程碑編號。

Title
title string

里程碑摘要。

State
state string

里程碑的開啟或關閉狀態。

里程碑
description string

里程碑的描述。

due_on
due_on string

里程碑的到期日。

傳回

相關問題和提取請求的集合。

response
Milestone

檢查使用者是否為存放庫共同作業者

檢查使用者是否為存放庫協作者。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

使用者名稱
userName True string

GitHub 使用者帳戶的控制碼。

傳回

擷取單一 API 回應的模型

response
object

比較兩個認可 (預覽版)

兩者 和 headbase必須是 中的分支名稱repositoryName。 若要比較與 相同 repositoryName網路中其他儲存庫的分支,請使用 <USERNAME>:branch格式 。 回應等同於執行 git log base..head 命令;不過,認可會依時間順序傳回。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

Base
base True string

基本參數

Head
head True string

頭部參數

傳回

提交比較

要求提取要求的檢閱者 (預覽版)

要求從一組指定的使用者和/或小組檢閱提取要求。

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

拉動編號
pullNumber True integer

拉號。

評論家
reviewers array of string
team_reviewers
team_reviewers array of string

觸發程序

建立或修改提取要求時 (預覽)

為提取請求創建 GitHub Webhook

當問題指派給我時

當問題指派給登入使用者時,會觸發此作業。

當指派給我的問題關閉時

當指派給已登入使用者的問題關閉時,會觸發此作業。

當新問題開啟並指派給我時

當問題開啟並指派給登入使用者時,會觸發此作業。

建立或修改提取要求時 (預覽)

為提取請求創建 GitHub Webhook

參數

名稱 機碼 必要 類型 Description
存放庫擁有者
repositoryOwner True string

儲存庫擁有者的名稱。

存放庫名稱
repositoryName True string

存放庫的名稱。

要接聽的 Webhook 事件
events True array of string

要接聽的 Webhook 事件

傳回

Webhook 提取要求回應。

當問題指派給我時

當問題指派給登入使用者時,會觸發此作業。

傳回

GitHub 問題的屬性。

當指派給我的問題關閉時

當指派給已登入使用者的問題關閉時,會觸發此作業。

傳回

GitHub 問題的屬性。

當新問題開啟並指派給我時

當問題開啟並指派給登入使用者時,會觸發此作業。

傳回

GitHub 問題的屬性。

定義

問題詳細資料模型

GitHub 問題的屬性。

名稱 路徑 類型 Description
Title
title string

問題摘要。

身體
body string

問題描述。

受託人
assignee UserDetailsModel

GitHub 使用者的屬性。

Id
number integer

問題的唯一識別碼。

State
state string

問題的狀態。

創建 Date-Time
created_at string

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

存放庫網址
repository_url string

儲存庫的 Web 連結。

MultipleSearchFetchModel

擷取搜尋結果的模型

名稱 路徑 類型 Description
body
body array of GeneralAPIModel

結果主體

MultipleFetch模型

擷取清單 API 回應的模型

名稱 路徑 類型 Description
物品
GeneralAPIModel

擷取單一 API 回應的模型

GeneralAPIModel

擷取單一 API 回應的模型

使用者詳細資料模型

GitHub 使用者的屬性。

名稱 路徑 類型 Description
登錄
login string

使用者登入。

Id
id integer

使用者 ID。

節點識別碼
node_id string

使用者節點識別碼。

頭像網址
avatar_url string

使用者頭像網址。

Gravatar Id
gravatar_id string

使用者 Gravatar ID。

網址
url string

使用者網址。

Html網址
html_url string

使用者 html url。

追蹤者網址
followers_url string

使用者追蹤者網址

以下網址
following_url string

使用者追蹤網址。

要點網址
gists_url string

使用者 Gist 網址。

加星號網址
starred_url string

使用者加星號的網址。

訂閱網址
subscriptions_url string

使用者訂閱 URL。

組織網址
organizations_url string

使用者組織網址。

存放庫網址
repos_url string

使用者存放庫 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
email string

用戶電子郵件。

可僱用
hireable boolean

用戶可僱用?

簡歷
bio string

用戶簡介。

公共儲存庫
public_repos integer

使用者公用存放庫。

公開要點
public_gists integer

用戶公共要點。

Followers
followers integer

用戶關注者。

Following
following integer

用戶關注。

創建於
created_at date-time

使用者建立於。

更新於
updated_at date-time

用戶更新於。

驗證

名稱 路徑 類型 Description
已驗證
verified boolean

指出 GitHub 是否將此認可中的簽章視為已驗證。

驗證原因
reason string

驗證價值的原因。

帶負符號值
payload string

已簽署的值。

認可簽章
signature string

從認可擷取的簽章。

GitUser

Git 作者/提交者資訊的中繼屬性。

名稱 路徑 類型 Description
Git 使用者名稱
name string

使用者名

Git 使用者電子郵件
email string

Email

提交時間戳記
date string

認可的時間戳記。

差異條目

差異條目

名稱 路徑 類型 Description
檔案名稱
filename string

更改了文件名。

新增內容
additions integer

檔案中新增的數目

刪除
deletions integer

檔案中的刪除次數

Changes
changes integer

檔案中的變更次數

地位
status string

變更的狀態已修改、重新命名等,

原始網址
raw_url string

檔案的原始 URL 連結

Blob 網址
blob_url string

檔案的 Blob URL 連結

Patch
patch string

對檔案所做的實際變更。

改變的沙
sha string

更改的 SHA。

內容網址
contents_url string

檔案內容 URL。

上一個檔案名稱
previous_filename string

如果檔案名稱已變更,則為上一個檔案名稱

承諾

承諾

名稱 路徑 類型 Description
認可網址
url string

認可的 HTTP URL。

提交沙
sha string

提交的SHA

節點識別碼
node_id string

認可的節點識別碼。

HTML 網址
html_url string

提交的 HTML URL

評論網址
comments_url string

註解 提交的 URL

認可網址
commit.url string

認可的 URL。

作者
commit.author GitUser

Git 作者/提交者資訊的中繼屬性。

提交者
commit.committer GitUser

Git 作者/提交者資訊的中繼屬性。

認可訊息
commit.message string

認可訊息。

評論計數
commit.comment_count integer

註解提交的計數

提交沙
commit.tree.sha string

提交的 SHA

認可網址
commit.tree.url uri

認可網址。

驗證
commit.verification Verification
作者
author UserDetailsModel

GitHub 使用者的屬性。

提交者
committer UserDetailsModel

GitHub 使用者的屬性。

父母
parents array of object
家長沙
parents.sha string

父分支提交 sha

父分支網址
parents.url string

父分支的 URL。

父分支 HTML 網址
parents.html_url string

父分支的 HTML URL。

新增內容
stats.additions integer

新增數量

刪除
stats.deletions integer

刪除次數

總數
stats.total integer

總變化

files
files array of DiffEntry

提交比較

提交比較

名稱 路徑 類型 Description
網址
url string

比較的網址

HTML 網址
html_url string

用於比較的 Html URL

永久網址
permalink_url string

用於比較的永久 URL

差異網址
diff_url string

差異網址

修補程式網址
patch_url string

修補程式網址

base_commit
base_commit Commit

承諾

merge_base_commit
merge_base_commit Commit

承諾

地位
status string

比較狀態,例如。發散等,

領先
ahead_by integer

按基地分支領先

後面有
behind_by integer

behind_by基分支

認可總數
total_commits integer

認可總數

認可
commits array of Commit

提交

檔案儲存體
files array of DiffEntry

files

動作公開金鑰

用於設定動作密碼的公開金鑰。

名稱 路徑 類型 Description
金鑰識別碼
key_id string

金鑰的識別碼。

Key
key string

Base64 編碼的公開金鑰。

Id
id integer

金鑰的唯一識別碼。

網址
url string

公開金鑰 url。

Title
title string

公開金鑰標題。

創建於
created_at string

建立金鑰的日期和時間。

許可證詳細資訊

授權詳細資料

名稱 路徑 類型 Description
Key
key string

授權的小寫 SPDX ID。

名稱
name string

由 指定的授權全名 https://spdx.org/licenses

網址
url uri

上授權 https://choosealicense.com的 URL 。

SPDX 識別碼
spdx_id string

由 指定的簡短識別碼 https://spdx.org/licenses

節點識別碼
node_id string

授權節點識別碼。

HTML 網址
html_url uri

授權 HTML URL。

存放庫MiniDetails

git 儲存庫

名稱 路徑 類型 Description
存放庫識別碼
id integer

存放庫的唯一識別碼。

儲存庫節點識別碼
node_id string

儲存庫的節點識別碼。

存放庫名稱
name string

存放庫的名稱。

儲存庫全名
full_name string

儲存庫的完整名稱。

管理員
permissions.admin boolean
提取
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

是否允許提取要求的變基合併。

儲存庫允許 Squash 合併
allow_squash_merge boolean

是否允許提取要求的 Squash 合併。

存放庫在合併時刪除分支
delete_branch_on_merge boolean

合併提取要求時是否要刪除前端分支

儲存庫允許合併認可
allow_merge_commit boolean

是否允許提取要求的合併認可。

儲存庫主分支
master_branch string

儲存庫主分支。

存放庫詳細資料

git 儲存庫

名稱 路徑 類型 Description
Id
id integer

存放庫的唯一識別碼。

節點識別碼
node_id string

儲存庫的節點識別碼。

名稱
name string

存放庫的名稱。

全名
full_name string

儲存庫的完整名稱。

許可證
license LicenseDetails

授權詳細資料

分支
forks integer

存放庫的分支數目。

管理員
permissions.admin boolean
提取
permissions.pull boolean
分級
permissions.triage boolean
推送
permissions.push boolean
保持
permissions.maintain boolean
擁有者
owner UserDetailsModel

GitHub 使用者的屬性。

是私人的嗎?
private boolean

儲存庫是私人還是公用。

Html網址
html_url uri

存放庫的 Html URL

Description
description string

儲存庫的描述

是叉子嗎?
fork boolean

如果存儲庫是分叉?

網址
url uri

此存放庫的 HTTP URL

存檔網址
archive_url string

此存放庫的封存 URL

受指派人網址
assignees_url string

此存放庫的受指派人 URL

Blob 網址
blobs_url string

此存放庫的 Blob URL

分支網址
branches_url string

此存放庫的分支 URL

協作者網址
collaborators_url string

此存放庫的協作者 URL

評論網址
comments_url string

此存放庫的註解 URL

認可網址
commits_url string

此存放庫的認可 URL

比較網址
compare_url string

此存放庫的比較 URL

內容網址
contents_url string

此存放庫的內容 URL

貢獻者網址
contributors_url uri

此存放庫的參與者 URL

部署網址
deployments_url uri

此存放庫的部署 URL

下載網址
downloads_url uri

此存放庫的下載URL

事件網址
events_url uri

此存放庫的事件 URL

分支網址
forks_url uri

此存放庫的分支 URL

Git 提交 URL
git_commits_url string

此存放庫的 Git 認可 URL

Git 參考網址
git_refs_url string

此存放庫的 Git 參考 URL

Git 標籤網址
git_tags_url string

此存放庫的 Git 標籤 URL

Git 網址
git_url string

此存放庫的 Git URL

問題註解網址
issue_comment_url string

此存放庫的問題註解 URL

問題事件 URL
issue_events_url string

此存放庫的問題事件 URL

問題網址
issues_url string

此存放庫的問題 URL

金鑰網址
keys_url string

此存放庫的金鑰 URL

標籤網址
labels_url string

此存放庫的標籤 URL

語言網址
languages_url uri

此存放庫的語言 URL

合併網址
merges_url uri

此存放庫的合併 URL

里程碑網址
milestones_url string

此存放庫的里程碑 URL

通知網址
notifications_url string

此存放庫的通知 URL

拉取網址
pulls_url string

此存放庫的提取 URL

發行網址
releases_url string

此存放庫的發行 URL

SSH 網址
ssh_url string

複製此儲存庫的 SSH URL

觀星者網址
stargazers_url uri

觀星者 (觀星者是已將 GitHub 存放庫加入書籤的人員) 此存放庫的 URL

狀態網址
statuses_url string

此存放庫的狀態 URL

訂閱者網址
subscribers_url uri

此存放庫的訂閱者 URL

訂閱網址
subscription_url uri

此存放庫的訂閱 URL

標籤網址
tags_url uri

此存放庫的標籤 URL

團隊網址
teams_url uri

此存放庫的小組 URL

樹狀結構網址
trees_url string

此存放庫的樹狀結構 URL

複製網址
clone_url string

此儲存庫的複製 URL

鏡像 URL
mirror_url uri

此存放庫的原始鏡像 URL

鉤子網址
hooks_url uri

此存放庫的勾點 URL

SVN 網址
svn_url uri

此存放庫的 SVN URL

首頁
homepage uri

此儲存庫的首頁

語言
language string

此儲存庫的語言

分叉計數
forks_count integer

整個網路中此儲存庫的分支數量。

觀星者計數
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

是否啟用專案。

有維基嗎?
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

是否允許提取要求的變基合併。

範本存放庫識別碼
template_repository.id integer

存放庫的唯一識別碼。

範本存放庫節點識別碼
template_repository.node_id string

儲存庫的節點識別碼。

範本存放庫名稱
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

範本存放庫封存網址
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

範本存放庫協作者網址
template_repository.collaborators_url string

此存放庫的協作者 URL

範本存放庫註解 URL
template_repository.comments_url string

此存放庫的註解 URL

範本存放庫認可 URL
template_repository.commits_url string

此存放庫的認可 URL

範本儲存庫比較網址
template_repository.compare_url string

此存放庫的比較 URL

範本存放庫內容 URL
template_repository.contents_url string

此存放庫的內容 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 參考網址
template_repository.git_refs_url string

此存放庫的 Git 參考 URL

範本存放庫 Git 標籤 URL
template_repository.git_tags_url string

此存放庫的 Git 標籤 URL

範本存放庫 Git 網址
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

範本存放庫語言網址
template_repository.languages_url uri

此存放庫的語言 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 網址
template_repository.stargazers_url uri

觀星者 (觀星者是已將 GitHub 存放庫加入書籤的人員) 此存放庫的 URL

範本存放庫狀態 URL
template_repository.statuses_url string

此存放庫的狀態 URL

範本存放庫訂閱者網址
template_repository.subscribers_url uri

此存放庫的訂閱者 URL

範本存放庫訂閱 URL
template_repository.subscription_url uri

此存放庫的訂閱 URL

範本存放庫標籤網址
template_repository.tags_url uri

此存放庫的標籤 URL

範本存放庫團隊網址
template_repository.teams_url uri

此存放庫的小組 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

整個網路中此儲存庫的分支數量。

模板存儲庫觀星者計數
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

是否啟用專案。

模板存儲庫有維基嗎?
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
提取
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

是否允許提取要求的 Squash 合併。

範本存放庫在合併時刪除分支
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

用於複製此儲存庫的臨時身份驗證令牌。

允許 Squash 合併
allow_squash_merge boolean

是否允許提取要求的 Squash 合併。

合併時刪除分支
delete_branch_on_merge boolean

合併提取要求時是否要刪除前端分支

允許合併提交
allow_merge_commit boolean

是否允許提取要求的合併認可。

訂閱者數量
subscribers_count integer

儲存庫的訂閱者數目。

網路計數
network_count integer

儲存庫網路計數

未解決的問題
open_issues integer

存放庫開啟問題。

Watchers
watchers integer

存放庫監看者。

主分支
master_branch string

儲存庫主分支。

主演於
starred_at string

儲存庫已加星標

Git參考

存放庫內的 Git 參考

名稱 路徑 類型 Description
Reference
ref string

完整參照的名稱。

節點識別碼
node_id string

參考的節點 ID。

網址
url uri

參考的 URL。

型別
object.type string

物件的類型。

object.sha string

SHA 供參考。

網址
object.url uri

物件的 URL。

PullRequestMerge結果

提取要求合併結果。

名稱 路徑 類型 Description
sha string

合併認可的 SHA。

合併了嗎?
merged boolean

提取要求是否已合併。

Message
message string

合併回應訊息。

里程碑

相關問題和提取請求的集合。

名稱 路徑 類型 Description
里程碑網址
url uri

里程碑的 HTTP URL。

里程碑 HTML 網址
html_url uri

里程碑的 HTML URL。

里程碑標籤網址
labels_url uri

里程碑的標籤 URL。

里程碑標識符
id integer

里程碑的唯一識別碼。

里程碑節點識別碼
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

里程碑的到期日。

標籤

顏色編碼標籤可協助您分類和篩選問題 (就像 Gmail 中的標籤一樣)。

名稱 路徑 類型 Description
Id
id integer

標籤的唯一識別碼。

節點識別碼
node_id string

標籤的節點 ID。

網址
url uri

標籤的網址

名稱
name string

標籤的名稱。

Description
description string

此標籤的簡要說明。

顏色
color string

6 個字元的十六進位代碼,沒有前導 #,用於識別顏色

是默認嗎?
default boolean

這是否是預設標籤。

團隊詳情

授予指定儲存庫許可權的組織成員群組。

名稱 路徑 類型 Description
Id
id integer

團隊的唯一識別碼。

節點識別碼
node_id string

小組的節點識別碼。

網址
url uri

小組的 URL。

會員網址
members_url string

團隊成員的 HTTP URL。

name string

團隊名稱

Description
description string

團隊簡介

權限
permission string

小組對其存放庫擁有的許可權

隱私權
privacy string

這個團隊應該擁有的隱私級別

HTML 網址
html_url uri

小組的 HTML URL。

存放庫網址
repositories_url uri

此小組儲存庫的 HTTP URL。

動態資料欄位
slug string

與團隊相對應的蛞蝓。

LDAP DN
ldap_dn string

團隊在 LDAP 環境中對應到的識別名稱 (DN)

拉取請求

提取請求可讓您告訴其他人您已推送至 GitHub 上存放庫的變更。 發送拉取請求後,感興趣的各方可以查看一組更改,討論潛在的修改,甚至在必要時推送後續提交。

名稱 路徑 類型 Description
提取要求網址
url uri

此提取要求的 HTTP URL。

提取要求識別碼
id integer

提取要求的唯一識別碼。

提取要求節點識別碼
node_id string

提取請求的節點識別碼。

提取要求 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

此提取要求的狀態。 openclosed

拉取請求是否被鎖定?
locked boolean

提取請求是否已鎖定。

提取要求標題
title string

提取請求的標題。

使用者
user UserDetailsModel

GitHub 使用者的屬性。

提取要求內文
body string

主體為 Markdown。

提取要求標籤
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 UserDetailsModel

GitHub 使用者的屬性。

提取要求受指派人
assignees array of UserDetailsModel

提取要求的受指派人清單。

提取要求檢閱者
requested_reviewers array of UserDetailsModel

指派給此提取要求的使用者清單。

提取要求的團隊
requested_teams array of TeamDetails

此提取請求的請求團隊列表。

提取請求標頭標籤
head.label string

頭部標籤。

提取要求標頭參考
head.ref string

頭部參考

存放庫
head.repo RepositoryMiniDetails

git 儲存庫

拉取請求頭沙
head.sha string

頭沙

使用者
head.user UserDetailsModel

GitHub 使用者的屬性。

提取要求基底標籤
base.label string

頭部標籤。

提取要求基底參考
base.ref string

頭部參考

存放庫
base.repo RepositoryMiniDetails

git 儲存庫

提取請求基底 sha
base.sha string

頭沙

使用者
base.user UserDetailsModel

GitHub 使用者的屬性。

Pull RequestAuthor 關聯
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

此提取要求中已變更的檔案數目。

PullRequest檔案

名稱 路徑 類型 Description
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

檔案的修補程式內容。

WebhookPullRequest回應

Webhook 提取要求回應。

名稱 路徑 類型 Description
執行的動作
action string

已執行的動作。

提取請求編號
number integer

提取要求號碼。

pull_request
pull_request PullRequest

提取請求可讓您告訴其他人您已推送至 GitHub 上存放庫的變更。 發送拉取請求後,感興趣的各方可以查看一組更改,討論潛在的修改,甚至在必要時推送後續提交。

物件

這是類型 'object'。