GitHub
GitHub 是一种基于 Web 的 Git 存储库托管服务。 它提供 Git 的所有分布式修订控制和源代码管理(SCM)功能,以及添加自己的功能。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 标准 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | Microsoft |
| URL | https://support.microsoft.com/ |
| abapi@microsoft.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://github.com/ |
| 隐私策略 | https://github.com/trust-center/privacy |
| 类别 | IT作;协作 |
连接器 github 应用发布者
此连接器使用 aaptapps 帐户的应用
连接器深入
有关连接器的详细信息,请参阅 深入部分。
已知问题和限制
请注意,触发器在分配给经过身份验证的用户的拥有存储库和成员存储库中搜索问题项。 不支持组织存储库。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
| 触发器轮询的频率 | 1 | 15 秒 |
操作
| Github MCP 服务器 |
Github MCP 服务器 |
| 从拉取请求中删除请求的审阅者(预览版) |
从给定的用户和/或团队的拉取请求中删除请求的审阅者。 |
| 从拉取请求获取文件列表(预览版) |
此作用于从存储库的拉取请求获取文件列表。 |
| 从组织机密中删除所选存储库(预览版) |
当存储库访问设置为 |
| 使用查询搜索 Github |
使用查询搜索 Github |
| 使用模板创建存储库(预览版) |
使用存储库模板创建新存储库。 经过身份验证的用户必须拥有或成为拥有存储库的组织的成员。 |
| 列出存储库中问题的可用分配者 |
列出存储库中问题的可用分配者。 |
| 列出存储库协作者 |
列出存储库协作者。 |
| 列出存储库的所有标签 |
列出存储库的所有标签。 |
| 列出存储库的所有里程碑 |
列出存储库的所有里程碑。 |
| 列出用户的所有公共存储库 |
列出用户的所有公共存储库。 |
| 列出组织的所有公共存储库 |
列出组织的所有公共存储库。 |
| 列出经过身份验证的用户的所有存储库 |
列出经过身份验证的用户的所有存储库(公共和专用)。 |
| 列出问题的所有标签 |
列出问题的所有标签。 |
| 创建存储库调度事件(预览版) |
此作是在希望 GitHub 外部发生的活动触发 GitHub Actions 工作流或 GitHub App Webhook 时调用 |
| 创建引用(预览版) |
为存储库创建引用。 即使使用的提交 SHA-1 哈希存在,也无法为空存储库创建新引用。 空存储库是没有分支的存储库。 |
| 创建或更新存储库机密(预览版) |
使用加密值创建或更新存储库机密。 使用 LibSodium 加密机密。 |
| 创建拉取请求(预览版) |
此作是在存储库中创建拉取请求。 若要在公共存储库中打开或更新拉取请求,必须具有对头或源分支的写入访问权限。 对于组织拥有的存储库,你必须是拥有存储库的组织的成员才能创建拉取请求。 |
| 创建问题 |
此作用于为特定存储库创建新问题。 |
|
删除 Git |
删除 GitHub Webhook |
| 合并拉取请求(预览版) |
此作用于合并存储库的拉取请求。 |
| 将所选存储库添加到组织机密(预览版) |
将存储库添加到组织机密中 |
| 按 ID 获取存储库(预览版) |
按 ID 获取存储库。 |
| 按状态和关键字查找问题 |
按状态和关键字查找问题。 |
| 更新拉取请求(预览版) |
此作用于更新存储库的拉取请求。 若要更新公共存储库中的拉取请求,必须具有对头或源分支的写入访问权限。 对于组织拥有的存储库,你必须是拥有存储库的组织的成员才能打开或更新拉取请求。 |
| 更新里程碑 |
更新现有里程碑。 |
| 更新问题 |
根据问题编号更新现有问题。 |
| 检查用户是否是存储库协作者 |
检查用户是否是存储库协作者。 |
| 比较两个提交(预览版) |
|
| 获取参考(预览版) |
从 Git 数据库返回单个引用。
|
| 获取存储库公钥(预览版) |
获取公钥,需要加密机密。 需要先加密机密,然后才能创建或更新机密。 |
| 获取存储库的所有拉取请求 |
获取存储库的所有拉取请求。 |
| 获取存储库的所有问题 |
获取存储库的所有问题。 |
| 获取存储库的特定问题 |
获取存储库的特定问题。 |
| 获取拉取请求(预览版) |
此作用于获取存储库的拉取请求。 |
| 获取经过身份验证的用户 |
获取经过身份验证的用户。 |
| 请求拉取请求的审阅者(预览版) |
请求从给定的用户和/或团队请求拉取请求。 |
Github MCP 服务器
Github MCP 服务器
从拉取请求中删除请求的审阅者(预览版)
从给定的用户和/或团队的拉取请求中删除请求的审阅者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
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 |
拉取编号。 |
返回
- response
- array of PullRequestFile
从组织机密中删除所选存储库(预览版)
当存储库访问设置为 admin:org 进行身份验证才能使用此终结点。 GitHub Apps 必须具有 secrets 组织权限才能使用此终结点。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库 ID
|
repositoryId | True | integer |
存储库的唯一标识符。 |
|
机密名称
|
secretName | True | string |
机密的名称。 |
使用查询搜索 Github
使用查询搜索 Github
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
查询
|
query | string |
查询 |
使用模板创建存储库(预览版)
使用存储库模板创建新存储库。 经过身份验证的用户必须拥有或成为拥有存储库的组织的成员。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板所有者
|
templateOwner | True | string |
模板存储库所有者的名称。 |
|
模板存储库
|
templateRepository | True | string |
模板存储库的名称。 |
|
所有者
|
owner | string |
将拥有新存储库的组织或人员。 如果留空,则经过身份验证的用户将是所有者。 |
|
|
Name
|
name | True | string |
新存储库的名称。 |
|
Description
|
description | string |
新存储库的简短说明。 |
|
|
是否为专用?
|
private | boolean |
|
返回
git 存储库
- Body
- RepositoryDetails
列出存储库中问题的可用分配者
列出存储库中问题的可用分配者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
列出存储库协作者
列出存储库协作者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
列出存储库的所有标签
列出存储库的所有标签。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
列出存储库的所有里程碑
列出存储库的所有里程碑。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
状态
|
state | string |
里程碑的状态。 |
|
|
排序
|
sort | string |
结果排序依据的内容。 |
|
|
方向
|
direction | string |
排序方向。 |
|
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
列出用户的所有公共存储库
列出用户的所有公共存储库。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
类型
|
type | string |
将结果限制为指定类型的存储库。 |
|
|
排序
|
sort | string |
要按其排序结果的属性。 |
|
|
方向
|
direction | string |
排序方向。 |
|
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要提取的页码 |
返回
用于提取列表 API 响应的模型
列出组织的所有公共存储库
列出组织的所有公共存储库。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
类型
|
type | string |
将结果限制为指定类型的存储库。 |
|
|
排序
|
sort | string |
要按其排序结果的属性。 |
|
|
方向
|
direction | string |
排序方向。 |
|
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要提取的页码 |
返回
用于提取列表 API 响应的模型
列出经过身份验证的用户的所有存储库
列出经过身份验证的用户的所有存储库(公共和专用)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
能见度
|
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 响应的模型
列出问题的所有标签
列出问题的所有标签。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
问题编号
|
issueNumber | True | integer |
给定问题的问题编号。 |
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
创建存储库调度事件(预览版)
此作是在希望 GitHub 外部发生的活动触发 GitHub Actions 工作流或 GitHub App Webhook 时调用 repository_dispatch 的 Webhook 事件。 必须将 GitHub Actions 工作流或 GitHub App 配置为在事件发生时 repository_dispatch 运行。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
事件名称
|
event_type | string |
自定义 Webhook 事件名称。 |
|
|
事件有效负载
|
client_payload | object |
包含有关作或工作洛可能使用的 Webhook 事件的额外信息的 JSON 有效负载。 |
创建引用(预览版)
为存储库创建引用。 即使使用的提交 SHA-1 哈希存在,也无法为空存储库创建新引用。 空存储库是没有分支的存储库。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
Reference
|
ref | True | string |
完全限定引用的名称(即: |
|
沙
|
sha | True | string |
此引用的 SHA1 值。 |
返回
存储库中的 Git 引用
- Body
- GitReference
创建或更新存储库机密(预览版)
使用加密值创建或更新存储库机密。 使用 LibSodium 加密机密。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
机密名称
|
secretName | True | string |
机密的名称。 |
|
encrypted_value
|
encrypted_value | string |
机密的值,使用从“获取存储库公钥”作中检索的公钥使用 LibSodium 加密。 |
|
|
key_id
|
key_id | string |
用于加密机密的密钥的 ID。 |
创建拉取请求(预览版)
此作是在存储库中创建拉取请求。 若要在公共存储库中打开或更新拉取请求,必须具有对头或源分支的写入访问权限。 对于组织拥有的存储库,你必须是拥有存储库的组织的成员才能创建拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
Title
|
title | string |
新拉取请求的标题。 |
|
|
Head
|
head | True | string |
实现更改的分支的名称。 对于同一网络中跨存储库拉取请求, |
|
基础
|
base | True | string |
要提取更改的分支的名称。 这应该是当前存储库上的现有分支。 无法将拉取请求提交到请求合并到另一个存储库的存储库。 |
|
Body
|
body | string |
拉取请求的内容。 |
|
|
维护者是否可以修改?
|
maintainer_can_modify | boolean |
指示维护人员是否可以修改拉取请求。 |
|
|
草稿
|
draft | boolean |
指示拉取请求是否为草稿。 |
返回
拉取请求可告知其他人已推送到 GitHub 上的存储库的更改。 发送拉取请求后,相关方可以查看更改集、讨论潜在修改,甚至在必要时推送后续提交。
- Body
- PullRequest
创建问题
此作用于为特定存储库创建新问题。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
Title
|
title | True | string |
问题的摘要。 |
|
Body
|
body | string |
问题的说明。 |
返回
GitHub 问题的属性。
- Body
- IssueDetailsModel
删除 GitHub Webhook (预览版)
删除 GitHub Webhook
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
GitHub Webhook ID
|
webhookId | True | string |
GitHub Webhook 的 ID |
合并拉取请求(预览版)
此作用于合并存储库的拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
拉取编号
|
pullNumber | True | integer |
拉取编号。 |
|
提交标题
|
commitTitle | string |
自动提交消息的标题。 |
|
|
提交消息
|
commitMessage | string |
追加到自动提交消息的额外详细信息。 |
|
|
沙
|
sha | string |
拉取请求头必须匹配的 SHA 才能允许合并。 |
|
|
Merge 方法
|
mergeMethod | string |
要使用的合并方法。 可能的值为 |
返回
拉取请求合并结果。
将所选存储库添加到组织机密(预览版)
将存储库添加到组织机密中 visibility ,当存储库访问设置为 selected。
创建或更新组织机密时,将设置可见性。 必须使用具有作用域的访问令牌 admin:org 进行身份验证才能使用此终结点。 GitHub Apps 必须具有 secrets 组织权限才能使用此终结点。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库 ID
|
repositoryId | True | integer |
存储库的唯一标识符。 |
|
机密名称
|
secretName | True | string |
机密的名称。 |
按 ID 获取存储库(预览版)
按 ID 获取存储库。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库 ID
|
repositoryId | True | integer |
存储库的唯一标识符。 |
返回
git 存储库
- Body
- RepositoryDetails
按状态和关键字查找问题
按状态和关键字查找问题。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
q
|
q | True | string |
搜索关键字和限定符。 |
|
排序
|
sort | string |
要按其排序结果的属性。 |
|
|
顺序
|
order | string |
排序方向。 |
|
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要提取的页码 |
返回
用于提取搜索结果的模型
更新拉取请求(预览版)
此作用于更新存储库的拉取请求。 若要更新公共存储库中的拉取请求,必须具有对头或源分支的写入访问权限。 对于组织拥有的存储库,你必须是拥有存储库的组织的成员才能打开或更新拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
拉取编号
|
pullNumber | True | integer |
拉取编号。 |
|
Title
|
title | string |
拉取请求的标题。 |
|
|
Body
|
body | string |
拉取请求的内容。 |
|
|
State
|
state | string |
此拉取请求的状态。
|
|
|
基础
|
base | string |
要提取更改的分支的名称。 这应该是当前存储库上的现有分支。 无法更新拉取请求上的基分支以指向另一个存储库。 |
|
|
维护者是否可以修改?
|
maintainer_can_modify | boolean |
指示维护人员是否可以修改拉取请求。 |
返回
拉取请求可告知其他人已推送到 GitHub 上的存储库的更改。 发送拉取请求后,相关方可以查看更改集、讨论潜在修改,甚至在必要时推送后续提交。
- Body
- PullRequest
更新里程碑
更新现有里程碑。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
里程碑编号
|
milestoneNumber | True | integer |
给定里程碑的里程碑编号。 |
|
Title
|
title | string |
里程碑摘要。 |
|
|
State
|
state | string |
里程碑的打开或关闭状态。 |
|
|
里程碑
|
description | string |
里程碑的说明。 |
|
|
due_on
|
due_on | string |
里程碑的截止日期。 |
返回
相关问题和拉取请求的集合。
- response
- Milestone
更新问题
根据问题编号更新现有问题。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
问题编号
|
issueNumber | True | integer |
给定问题的问题编号。 |
|
Title
|
title | string |
问题的摘要。 |
|
|
Body
|
body | string |
问题的说明。 |
|
|
代理人
|
assignee | string |
问题的被分配者。 |
|
|
State
|
state | string |
问题的打开或关闭状态。 可以是打开或关闭之一。 |
|
|
ChangeReason
|
state_reason | string |
状态更改的原因。 |
|
|
里程碑
|
milestone | string |
要与问题关联的里程碑数。 |
|
|
labels
|
labels | array of string |
与问题关联的标签。 |
|
|
assignees
|
assignees | array of string |
要分配给问题的 UserSnames。 |
返回
GitHub 问题的属性。
- Body
- IssueDetailsModel
检查用户是否是存储库协作者
检查用户是否是存储库协作者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
用户名
|
userName | True | string |
GitHub 用户帐户的句柄。 |
返回
用于提取单个 API 响应的模型
- response
- object
比较两个提交(预览版)
head两者base都必须是分支名称。repositoryName 若要比较同一网络中 repositoryName其他存储库中的分支,请使用格式 <USERNAME>:branch。 响应等效于运行 git log base..head 命令;但是,提交按时间顺序返回。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
基础
|
base | True | string |
base 参数 |
|
Head
|
head | True | string |
head 参数 |
返回
提交比较
- Body
- CommitComparison
获取参考(预览版)
从 Git 数据库返回单个引用。
reference参数的格式必须设置为heads/<branch name>分支和tags/<tag name>标记。 如果与 reference 现有 ref 不匹配,则返回 a 404 。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
Reference
|
reference | True | string |
URL 中的 ref 必须格式化为分支的头/<分支名称> ,以及标记的标记/<标记名称> 。 |
返回
存储库中的 Git 引用
- Body
- GitReference
获取存储库公钥(预览版)
获取公钥,需要加密机密。 需要先加密机密,然后才能创建或更新机密。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
返回
用于设置作机密的公钥。
- Body
- ActionsPublicKey
获取存储库的所有拉取请求
获取存储库的所有拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
状态
|
state | string |
按状态筛选。 |
|
|
头
|
head | string |
按头用户或组织进行筛选。 |
|
|
基础映像
|
base | string |
按基分支名称进行筛选。 |
|
|
排序
|
sort | string |
结果排序依据的内容。 |
|
|
方向
|
direction | string |
排序方向。 |
|
|
perPage
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
获取存储库的所有问题
获取存储库的所有问题。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
里程碑
|
milestone | string |
按里程碑进行筛选。 |
|
|
状态
|
state | string |
按状态筛选。 |
|
|
代理人
|
assignee | string |
按被分配者进行筛选。 |
|
|
创建者
|
creator | string |
按创建者进行筛选。 |
|
|
mentioned
|
mentioned | string |
按提及进行筛选。 |
|
|
labels
|
labels | string |
按标签名称进行筛选。 |
|
|
排序
|
sort | string |
要按其排序结果的字段。 |
|
|
方向
|
direction | string |
排序方向。 |
|
|
因为
|
since | string |
按给定日期后的问题进行筛选。 |
|
|
per_page
|
per_page | integer |
每页结果数。 |
|
|
页面
|
page | integer |
要显示的页码。 |
返回
用于提取列表 API 响应的模型
获取存储库的特定问题
获取存储库的特定问题。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
问题编号
|
issueNumber | True | integer |
给定问题的问题编号。 |
返回
GitHub 问题的属性。
- Body
- IssueDetailsModel
获取拉取请求(预览版)
此作用于获取存储库的拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
拉取编号
|
pullNumber | True | integer |
拉取编号。 |
返回
拉取请求可告知其他人已推送到 GitHub 上的存储库的更改。 发送拉取请求后,相关方可以查看更改集、讨论潜在修改,甚至在必要时推送后续提交。
- Body
- PullRequest
获取经过身份验证的用户
请求拉取请求的审阅者(预览版)
请求从给定的用户和/或团队请求拉取请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
拉取编号
|
pullNumber | True | integer |
拉取编号。 |
|
评论家
|
reviewers | array of string | ||
|
team_reviewers
|
team_reviewers | array of string |
触发器
| 分配给我的问题关闭时 |
当分配给已登录用户的问题关闭时,此作将触发。 |
| 创建或修改拉取请求时(预览版) |
为拉取请求创建 GitHub Webhook |
| 向我分配问题时 |
当向登录用户分配问题时,此作将触发。 |
| 打开新问题并将其分配给我时 |
当问题打开并分配给已登录用户时,此作将触发。 |
分配给我的问题关闭时
创建或修改拉取请求时(预览版)
为拉取请求创建 GitHub Webhook
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
存储库所有者
|
repositoryOwner | True | string |
存储库所有者的名称。 |
|
存储库名称
|
repositoryName | True | string |
存储库的名称。 |
|
要侦听的 Webhook 事件
|
events | True | array of string |
要侦听的 Webhook 事件 |
返回
Webhook 拉取请求响应。
向我分配问题时
打开新问题并将其分配给我时
定义
IssueDetailsModel
GitHub 问题的属性。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
title | string |
问题的摘要。 |
|
Body
|
body | string |
问题的说明。 |
|
代理人
|
assignee | UserDetailsModel |
GitHub 用户的属性。 |
|
Id
|
number | integer |
问题的唯一 ID。 |
|
State
|
state | string |
问题的状态。 |
|
已创建 Date-Time
|
created_at | string |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC 格式)。 |
|
存储库 URL
|
repository_url | string |
指向存储库的 Web 链接。 |
MultipleSearchFetchModel
用于提取搜索结果的模型
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
身体
|
body | array of GeneralAPIModel |
结果正文 |
MultipleFetchModel
用于提取列表 API 响应的模型
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
物品
|
GeneralAPIModel |
用于提取单个 API 响应的模型 |
GeneralAPIModel
用于提取单个 API 响应的模型
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 | string |
用户 URL。 |
|
Html Url
|
html_url | string |
用户 Html URL。 |
|
关注者 URL
|
followers_url | string |
User 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。 |
|
存储库 URL
|
repos_url | string |
用户存储库 URL。 |
|
事件 URL
|
events_url | string |
用户事件 URL。 |
|
接收的事件 URL
|
received_events_url | string |
用户收到的事件 URL。 |
|
类型
|
type | string |
用户类型。 |
|
网站管理员
|
site_admin | boolean |
用户网站管理员吗? |
|
Name
|
name | string |
用户名。 |
|
公司
|
company | string |
用户公司。 |
|
博客
|
blog | string |
用户博客。 |
|
位置
|
location | string |
用户位置。 |
|
Email
|
string |
用户电子邮件。 |
|
|
Hireable
|
hireable | boolean |
用户可雇用? |
|
个人简介
|
bio | string |
用户生物。 |
|
公共存储库
|
public_repos | integer |
用户公共存储库。 |
|
公共 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 用户电子邮件
|
string |
|
|
|
提交时间戳
|
date | string |
提交时间戳。 |
DiffEntry
差异条目
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文件名
|
filename | string |
更改了文件名。 |
|
增加
|
additions | integer |
文件中的添加数 |
|
删除
|
deletions | integer |
文件中的删除次数 |
|
Changes
|
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
|
previous_filename | string |
如果 FileName 已更改,则为以前的 FileName |
提交
提交
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
提交 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 |
Commit 的 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 |
删除次数 |
|
Total
|
stats.total | integer |
更改总数 |
|
files
|
files | array of DiffEntry |
CommitComparison
提交比较
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
网址
|
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 |
比较的状态,例如分化等, |
|
领先者
|
ahead_by | integer |
按基分支提前 |
|
隐藏者
|
behind_by | integer |
behind_by基分支 |
|
提交总数
|
total_commits | integer |
提交总数 |
|
提交
|
commits | array of Commit |
提交 |
|
文件存储
|
files | array of DiffEntry |
files |
ActionsPublicKey
用于设置作机密的公钥。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
密钥 ID
|
key_id | string |
密钥的标识符。 |
|
Key
|
key | string |
Base64 编码的公钥。 |
|
Id
|
id | integer |
密钥的唯一标识符。 |
|
网址
|
url | string |
公钥 URL。 |
|
Title
|
title | string |
公钥标题。 |
|
创建时间
|
created_at | string |
创建密钥的日期和时间。 |
许可证详细信息
许可证详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Key
|
key | string |
许可证的小写 SPDX ID。 |
|
Name
|
name | string |
由 https://spdx.org/licenses. 指定的许可证全名。 |
|
网址
|
url | uri |
许可证的 https://choosealicense.comURL。 |
|
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 | |
|
拉取
|
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 |
上次更新存储库的日期和时间。 |
|
存储库允许重新base 合并
|
allow_rebase_merge | boolean |
是否允许对拉取请求进行重新基合并。 |
|
存储库允许 Squash 合并
|
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
|
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 Url
|
html_url | uri |
存储库的 Html URL |
|
Description
|
description | string |
存储库的说明 |
|
是分支吗?
|
fork | boolean |
如果存储库是分叉? |
|
网址
|
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 (Stargazers 是已为此存储库添加书签的 GitHub 存储库)URL 的人员 |
|
状态 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 |
此存储库的团队 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 Count
|
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 |
上次更新存储库的日期和时间。 |
|
允许重新Base 合并
|
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 (Stargazers 是已为此存储库添加书签的 GitHub 存储库)URL 的人员 |
|
模板存储库状态 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 |
此存储库的团队 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 | |
|
拉取
|
template_repository.permissions.pull | boolean | |
|
模板存储库允许重新Base 合并
|
template_repository.allow_rebase_merge | boolean |
是否允许对拉取请求进行重新基合并。 |
|
模板存储库的模板存储库
|
template_repository.template_repository | string |
模板存储库。 |
|
模板存储库临时克隆令牌
|
template_repository.temp_clone_token | string |
用于克隆此存储库的临时身份验证令牌。 |
|
模板存储库允许 Squash 合并
|
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 |
用于克隆此存储库的临时身份验证令牌。 |
|
允许 Squash 合并
|
allow_squash_merge | boolean |
是否允许请求进行壁式合并。 |
|
在合并时删除分支
|
delete_branch_on_merge | boolean |
合并拉取请求时是否删除头分支 |
|
允许合并提交
|
allow_merge_commit | boolean |
是否允许请求的合并提交。 |
|
订阅服务器计数
|
subscribers_count | integer |
存储库的订阅服务器数。 |
|
网络计数
|
network_count | integer |
存储库网络计数 |
|
未解决的问题
|
open_issues | integer |
存储库打开问题。 |
|
Watchers
|
watchers | integer |
存储库观察程序。 |
|
Master Branch
|
master_branch | string |
存储库主分支。 |
|
星号
|
starred_at | string |
存储库星号 |
GitReference
存储库中的 Git 引用
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Reference
|
ref | string |
完全限定引用的名称。 |
|
节点 ID
|
node_id | string |
引用的节点 ID。 |
|
网址
|
url | uri |
引用的 URL。 |
|
类型
|
object.type | string |
对象的类型。 |
|
沙
|
object.sha | string |
引用的 SHA。 |
|
网址
|
object.url | uri |
对象的 URL。 |
PullRequestMergeResult
拉取请求合并结果。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
沙
|
sha | string |
合并提交的 SHA。 |
|
是否合并?
|
merged | boolean |
拉取请求是否已合并。 |
|
Message
|
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 |
里程碑的截止日期。 |
标签
颜色编码的标签有助于对问题进行分类和筛选(就像 Gmail 中的标签一样)。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | integer |
标签的唯一标识符。 |
|
节点 ID
|
node_id | string |
标签的节点 ID。 |
|
网址
|
url | uri |
标签的 URL |
|
Name
|
name | string |
标签的名称。 |
|
Description
|
description | string |
此标签的简要说明。 |
|
颜色
|
color | string |
6 个字符十六进制代码,不带前导 #,标识颜色 |
|
默认值是吗?
|
default | boolean |
这是否为默认标签。 |
TeamDetails
授予指定存储库权限的组织成员组。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | integer |
团队的唯一标识符。 |
|
节点 ID
|
node_id | string |
团队的节点 ID。 |
|
网址
|
url | uri |
团队的 URL。 |
|
成员 URL
|
members_url | string |
团队成员的 HTTP URL。 |
|
|
name | string |
团队的名称 |
|
Description
|
description | string |
团队说明 |
|
许可
|
permission | string |
团队对其存储库拥有的权限 |
|
隐私
|
privacy | string |
此团队应具有的隐私级别 |
|
HTML Url
|
html_url | uri |
团队的 HTML URL。 |
|
存储库 URL
|
repositories_url | uri |
此团队存储库的 HTTP URL。 |
|
Slug
|
slug | string |
对应于团队的滑行。 |
|
LDAP DN
|
ldap_dn | string |
团队映射到 LDAP 环境中的可分辨名称 (DN) |
拉取请求
拉取请求可告知其他人已推送到 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 |
拉取请求的 Diff 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 |
拉取请求的 Diff URL。 |
|
拉取请求状态 URL
|
statuses_url | uri |
拉取请求的状态 URL。 |
|
拉取请求编号
|
number | integer |
唯一标识其存储库中的拉取请求的数字。 |
|
拉取请求状态
|
state | string |
此拉取请求的状态。
|
|
拉取请求是否已锁定?
|
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 存储库 |
|
拉取请求头 Sha
|
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 用户的属性。 |
|
拉取 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 |
此拉取请求中已更改的文件数。 |
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 上的存储库的更改。 发送拉取请求后,相关方可以查看更改集、讨论潜在修改,甚至在必要时推送后续提交。 |
对象
这是 'object' 类型。