分支
GitHub 仓库的分支。用于获取给定分支上最后一次构建的信息。
如果使用仓库标识符进行查询,则必须使用 标准 URL 编码,包括任何特殊字符。
属性
最小表示
在资源作为另一个资源的一部分返回时包含。
名称 | 类型 | 描述 |
---|---|---|
name | 字符串 | git 分支的名称。 |
标准表示
在资源是请求的主要响应时包含,或者是被 预加载 的。
名称 | 类型 | 描述 |
---|---|---|
name | 字符串 | git 分支的名称。 |
repository | 仓库 | 分支所属的 GitHub 用户或组织。 |
default_branch | 布尔值 | 是否为仓库的默认分支。 |
exists_on_github | 布尔值 | 该分支是否还存在于 GitHub 上。 |
last_build | 构建 | 该分支上的最后一次构建。 |
附加属性
名称 | 类型 | 描述 |
---|---|---|
recent_builds | [构建] | 该分支上的最近 10 次构建(当使用 `include=branch.recent_builds` 时)。 |
操作
查找
这将返回有关单个分支的信息。请求可以包含仓库 ID 或标识符。
GET
/repo/{provider}/{repository.id}/branch/{branch.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.id | 整数 | 唯一标识仓库的值。 |
branch.name | 字符串 | git 分支的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
GET
/repo/{provider}/{repository.slug}/branch/{branch.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
branch.name | 字符串 | git 分支的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
GET
/repo/{repository.id}/branch/{branch.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.id | 整数 | 唯一标识仓库的值。 |
branch.name | 字符串 | git 分支的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
示例GET /repo/891/branch/master
GET
/repo/{repository.slug}/branch/{branch.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
branch.name | 字符串 | git 分支的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
示例GET /repo/rails%2Frails/branch/master