分支
分支列表。
如果使用仓库 slug 查询，则必须使用 标准 URL 编码 格式，包括任何特殊字符。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
| 分支 | [分支] | 分支列表。 |
集合项
branches 数组中的每个条目都具有以下属性
| 名称 | 类型 | 描述 |
|---|---|---|
| 名称 | 字符串 | git 分支的名称。 |
| 仓库 | 仓库 | 分支所属的 GitHub 用户或组织。 |
| 默认分支 | 布尔值 | 这是否是仓库的默认分支。 |
| 存在于 GitHub 上 | 布尔值 | 分支是否仍然存在于 GitHub 上。 |
| 最后构建 | 构建 | 分支上的最后构建。 |
| 最近构建 | [构建] | 分支上的最后 10 次构建（当使用 `include=branch.recent_builds` 时）。 |
动作
查找
这将返回仓库在 GitHub 上拥有的分支列表。
获取
/repo/{provider}/{repository.id}/branches
| 模板变量 | 类型 | 描述 |
|---|---|---|
| 提供者 | 未知 | 文档缺失。 |
| repository.id | 整数 | 唯一标识仓库的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.exists_on_github | [布尔值] | 根据分支是否仍然存在于 GitHub 上来过滤分支。 |
| branch.name | [字符串] | 根据 git 分支的名称来过滤分支。 |
| 存在于 GitHub 上 | [布尔值] | 别名branch.exists_on_github. |
| 包括 | [字符串] | 要 急切加载 的属性列表。 |
| 限制 | 整数 | 响应中要包含多少个分支。用于 分页。 |
| 名称 | [字符串] | 别名branch.name. |
| 偏移量 | 整数 | 在响应中的第一个条目之前要跳过多少个分支。用于 分页。 |
| 排序 | [字符串] | 要根据其对分支进行排序的属性。用于 分页。 |
可排序名称, 最后构建, 存在于 GitHub 上, 默认分支, 附加:desc到任何属性以反转顺序。
默认值为default_branch,exists_on_github,last_build:desc.
获取
/repo/{provider}/{repository.slug}/branches
| 模板变量 | 类型 | 描述 |
|---|---|---|
| 提供者 | 未知 | 文档缺失。 |
| repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.exists_on_github | [布尔值] | 根据分支是否仍然存在于 GitHub 上来过滤分支。 |
| branch.name | [字符串] | 根据 git 分支的名称来过滤分支。 |
| 存在于 GitHub 上 | [布尔值] | 别名branch.exists_on_github. |
| 包括 | [字符串] | 要 急切加载 的属性列表。 |
| 限制 | 整数 | 响应中要包含多少个分支。用于 分页。 |
| 名称 | [字符串] | 别名branch.name. |
| 偏移量 | 整数 | 在响应中的第一个条目之前要跳过多少个分支。用于 分页。 |
| 排序 | [字符串] | 要根据其对分支进行排序的属性。用于 分页。 |
可排序名称, 最后构建, 存在于 GitHub 上, 默认分支, 附加:desc到任何属性以反转顺序。
默认值为default_branch,exists_on_github,last_build:desc.
获取
/repo/{repository.id}/branches
| 模板变量 | 类型 | 描述 |
|---|---|---|
| repository.id | 整数 | 唯一标识仓库的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.exists_on_github | [布尔值] | 根据分支是否仍然存在于 GitHub 上来过滤分支。 |
| branch.name | [字符串] | 根据 git 分支的名称来过滤分支。 |
| 存在于 GitHub 上 | [布尔值] | 别名branch.exists_on_github. |
| 包括 | [字符串] | 要 急切加载 的属性列表。 |
| 限制 | 整数 | 响应中要包含多少个分支。用于 分页。 |
| 名称 | [字符串] | 别名branch.name. |
| 偏移量 | 整数 | 在响应中的第一个条目之前要跳过多少个分支。用于 分页。 |
| 排序 | [字符串] | 要根据其对分支进行排序的属性。用于 分页。 |
示例GET /repo/891/branches?limit=5&exists_on_github=true
可排序名称, 最后构建, 存在于 GitHub 上, 默认分支, 附加:desc到任何属性以反转顺序。
默认值为default_branch,exists_on_github,last_build:desc.
获取
/repo/{repository.slug}/branches
| 模板变量 | 类型 | 描述 |
|---|---|---|
| repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.exists_on_github | [布尔值] | 根据分支是否仍然存在于 GitHub 上来过滤分支。 |
| branch.name | [字符串] | 根据 git 分支的名称来过滤分支。 |
| 存在于 GitHub 上 | [布尔值] | 别名branch.exists_on_github. |
| 包括 | [字符串] | 要 急切加载 的属性列表。 |
| 限制 | 整数 | 响应中要包含多少个分支。用于 分页。 |
| 名称 | [字符串] | 别名branch.name. |
| 偏移量 | 整数 | 在响应中的第一个条目之前要跳过多少个分支。用于 分页。 |
| 排序 | [字符串] | 要根据其对分支进行排序的属性。用于 分页。 |
示例GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
可排序名称, 最后构建, 存在于 GitHub 上, 默认分支, 附加:desc到任何属性以反转顺序。
默认值为default_branch,exists_on_github,last_build:desc.