设置
单个仓库设置。这些是仓库上可以由用户调整的设置。目前用户可以修改五种不同的设置。
builds_only_with_travis_yml
(布尔值)build_pushes
(布尔值)build_pull_requests
(布尔值)maximum_number_of_builds
(整数)auto_cancel_pushes
(布尔值)auto_cancel_pull_requests
(布尔值)share_encrypted_env_with_forks
(布尔值)share_ssh_keys_with_forks
(布尔值)job_log_time_based_limit
(布尔值)job_log_access_based_limit
(布尔值)
如果使用仓库标识符进行查询,则必须使用 标准 URL 编码 格式,包括任何特殊字符。
属性
标准表示
当资源是请求的主要响应或被 预加载 时包含。
名称 | 类型 | 描述 |
---|---|---|
name | 字符串 | 设置的名称。 |
value | 布尔值或整数 | 设置的值。 |
最小表示
当资源作为另一个资源的一部分返回时包含。
名称 | 类型 | 描述 |
---|---|---|
name | 字符串 | 设置的名称。 |
value | 布尔值或整数 | 设置的值。 |
操作
查找
这将返回单个设置。可以在请求中使用仓库 ID 或标识符。
GET
/repo/{provider}/{repository.id}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.id | 整数 | 唯一标识仓库的值。 |
setting.name | 字符串 | 设置的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
GET
/repo/{provider}/{repository.slug}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
setting.name | 字符串 | 设置的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
GET
/repo/{repository.id}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.id | 整数 | 唯一标识仓库的值。 |
setting.name | 字符串 | 设置的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
GET
/repo/{repository.slug}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
setting.name | 字符串 | 设置的名称。 |
查询参数 | 类型 | 描述 |
---|---|---|
include | [字符串] | 要 预加载 的属性列表。 |
更新
这将更新单个设置。可以在请求中使用仓库 ID 或标识符。
在请求正文中使用命名空间参数传递新设置
curl -X PATCH \ -H "Content-Type: application/json" \ -H "Travis-API-Version: 3" \ -H "Authorization: token xxxxxxxxxxxx" \ -d '{ "setting.value": true }' \ https://api.travis-ci.com/repo/1234/setting/{setting.name}
PATCH
/repo/{provider}/{repository.id}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.id | 整数 | 唯一标识仓库的值。 |
setting.name | 字符串 | 设置的名称。 |
接受的参数 | 类型 | 描述 |
---|---|---|
setting.value | 布尔值或整数 | 设置的值。 |
PATCH
/repo/{provider}/{repository.slug}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
provider | 未知 | 文档缺失。 |
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
setting.name | 字符串 | 设置的名称。 |
接受的参数 | 类型 | 描述 |
---|---|---|
setting.value | 布尔值或整数 | 设置的值。 |
PATCH
/repo/{repository.id}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.id | 整数 | 唯一标识仓库的值。 |
setting.name | 字符串 | 设置的名称。 |
接受的参数 | 类型 | 描述 |
---|---|---|
setting.value | 布尔值或整数 | 设置的值。 |
PATCH
/repo/{repository.slug}/setting/{setting.name}
模板变量 | 类型 | 描述 |
---|---|---|
repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
setting.name | 字符串 | 设置的名称。 |
接受的参数 | 类型 | 描述 |
---|---|---|
setting.value | 布尔值或整数 | 设置的值。 |