Travis CI API 文档

请求

请求列表。

如果使用仓库 slug 查询,则必须使用标准 URL 编码格式化,包括任何特殊字符。

属性

名称类型描述
请求[请求]请求列表。

集合项

requests 数组中的每个条目都具有以下属性

名称类型描述
id整数唯一标识请求的值。
状态字符串请求的状态(例如,是否已处理)。
结果字符串请求的结果(例如,拒绝或批准)。
消息字符串附加到请求的 Travis-ci 状态消息。
pull_request_mergeable未知请求的 pull_request_mergeable。
仓库仓库请求所属的 GitHub 用户或组织。
分支名称字符串请求构建的分支名称。
提交提交请求关联的提交。
构建[构建]请求的构建。
所有者所有者请求所属的 GitHub 用户或组织。
创建时间字符串Travis CI 创建请求的时间。
事件类型字符串请求来源(推送、拉取请求、api)。
基础提交字符串请求关联的基础提交。
头提交字符串请求关联的头提交。
消息未知请求的消息。
配置对象构建配置(从 .travis.yml 解析)。
原始配置未知请求的原始配置。
yaml 配置未知请求的 yaml 配置。

操作

查找

这将返回属于仓库的请求列表。

GET
/repo/{provider}/{repository.id}/requests
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
查询参数类型描述
include[字符串]急切加载的属性列表。
limit整数响应中包含的请求数。用于分页
offset整数响应中第一个条目之前的请求数。用于分页
GET
/repo/{provider}/{repository.slug}/requests
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
查询参数类型描述
include[字符串]急切加载的属性列表。
limit整数响应中包含的请求数。用于分页
offset整数响应中第一个条目之前的请求数。用于分页
GET
/repo/{repository.id}/requests
模板变量类型描述
repository.id整数唯一标识仓库的值。
查询参数类型描述
include[字符串]急切加载的属性列表。
limit整数响应中包含的请求数。用于分页
offset整数响应中第一个条目之前的请求数。用于分页

示例GET /repo/891/requests?limit=5

GET
/repo/{repository.slug}/requests
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
查询参数类型描述
include[字符串]急切加载的属性列表。
limit整数响应中包含的请求数。用于分页
offset整数响应中第一个条目之前的请求数。用于分页

示例GET /repo/rails%2Frails/requests?limit=5

创建

这将为单个仓库创建一个请求,触发 Travis CI 上的构建运行。

在请求主体中使用命名空间参数以 JSON 格式传递任何接受的参数。请求配置中的任何键都将覆盖 .travis.yml 中存在的键。

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "request": {
        "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  https://api.travis-ci.com/repo/1/requests

响应包含以下主体

{
  "@type":              "pending",
  "remaining_requests": 1,
  "repository":         {
    "@type":            "repository",
    "@href":            "/repo/1",
    "@representation":  "minimal",
    "id":               1,
    "name":             "test",
    "slug":             "owner/repo"
  },
  "request":            {
    "repository":       {
      "id":             1,
      "owner_name":     "owner",
      "name":           "repo"
    },
    "user":             {
      "id":             1
    },
    "id":               1,
    "message":          "Override the commit message: this is an api request",
    "branch":           "master",
    "config":           { }
  },
  "resource_type":      "request"
}
POST
/repo/{provider}/{repository.id}/requests
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
接受的参数类型描述
request.merge_mode未知文档缺失。
request.config对象构建配置(从 .travis.yml 解析)。
request.configs未知文档缺失。
request.message字符串附加到请求的 Travis-ci 状态消息。
request.branch字符串请求构建的分支。
request.sha未知文档缺失。
request.token对象与 GitHub 上的 webhook 关联的 Travis 令牌(已弃用)。
POST
/repo/{provider}/{repository.slug}/requests
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
request.merge_mode未知文档缺失。
request.config对象构建配置(从 .travis.yml 解析)。
request.configs未知文档缺失。
request.message字符串附加到请求的 Travis-ci 状态消息。
request.branch字符串请求构建的分支。
request.sha未知文档缺失。
request.token对象与 GitHub 上的 webhook 关联的 Travis 令牌(已弃用)。
POST
/repo/{repository.id}/requests
模板变量类型描述
repository.id整数唯一标识仓库的值。
接受的参数类型描述
request.merge_mode未知文档缺失。
request.config对象构建配置(从 .travis.yml 解析)。
request.configs未知文档缺失。
request.message字符串附加到请求的 Travis-ci 状态消息。
request.branch字符串请求构建的分支。
request.sha未知文档缺失。
request.token对象与 GitHub 上的 webhook 关联的 Travis 令牌(已弃用)。

示例POST /repo/891/requests

POST
/repo/{repository.slug}/requests
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
request.merge_mode未知文档缺失。
request.config对象构建配置(从 .travis.yml 解析)。
request.configs未知文档缺失。
request.message字符串附加到请求的 Travis-ci 状态消息。
request.branch字符串请求构建的分支。
request.sha未知文档缺失。
request.token对象与 GitHub 上的 webhook 关联的 Travis 令牌(已弃用)。

示例POST /repo/rails%2Frails/requests