REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."

用于规则集的 REST API 端点

使用 REST API 管理存储库的规则集。

列出存储库规则集

列出存储库级别的规则评估套件。有关更多信息，请参阅 "管理存储库的规则集."

用于“列出存储库规则集”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”存储库权限（写入）

用于“列出存储库规则集”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不含 .git 扩展名。名称不区分大小写。

查询参数
ref string

引用的名称。不能包含通配符。指定后，将仅返回为此引用触发的规则评估。

time_period string

用于过滤的时间段。

例如，day 将过滤过去 24 小时内发生的规则集，week 将过滤过去 7 天（168 小时）内发生的洞察。

默认: day

可以是以下之一: hour, day, week, month

actor_name string

用于过滤的 GitHub 用户帐户的句柄。指定此参数后，只会返回由该操作者触发的规则评估。

rule_suite_result 字符串

要过滤的规则结果。指定此参数后，只会返回具有此结果的套件。

默认值: all

可以是以下之一: pass, fail, bypass, all

per_page 整数

每页结果的数量（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。

默认值: 30

page 整数

要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。

默认值: 1

“列出仓库规则套件”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

500

内部错误

“列出仓库规则套件”的代码示例

请求示例

get/repos/{owner}/{repo}/rulesets/rule-suites
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets/rule-suites

响应

状态：200
[ { "id": 21, "actor_id": 12, "username": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", "repository_id": 404, "repository_name": "octo-repo", "pushed_at": "2023-07-06T08:43:03Z", "result": "bypass" }, { "id": 25, "actor_id": 11, "username": "not-octocat", "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", "ref": "refs/heads/i-am-everything", "repository_id": 404, "repository_name": "octo-repo", "pushed_at": "2023-07-07T08:43:03Z", "result": "pass", "evaluation_result": "fail" } ]

获取仓库规则集

获取仓库内规则评估套件的信息。有关更多信息，请参阅“管理仓库的规则集”。

“获取仓库规则集”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”存储库权限（写入）

“获取仓库规则集”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不含 .git 扩展名。名称不区分大小写。

rule_suite_id 整数 必需

规则集结果的唯一标识符。要获取此 ID，您可以使用 GET /repos/{owner}/{repo}/rulesets/rule-suites 用于仓库，以及 GET /orgs/{org}/rulesets/rule-suites 用于组织。

“获取仓库规则集”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

500

内部错误

“获取仓库规则集”的代码示例

请求示例

get/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets/rule-suites/RULE_SUITE_ID

响应

状态：200
{ "id": 21, "actor_id": 12, "username": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", "repository_id": 404, "repository_name": "octo-repo", "pushed_at": "2023-07-06T08:43:03Z", "result": "bypass", "evaluation_result": "fail", "rule_evaluations": [ { "rule_source": { "type": "ruleset", "id": 2, "name": "Author email must be a GitHub email address" }, "enforcement": "active", "result": "pass", "rule_type": "commit_author_email_pattern" }, { "rule_source": { "type": "protected_branch" }, "enforcement": "active", "result": "fail", "rule_type": "pull_request", "details": "Changes must be made through a pull request." }, { "rule_source": { "type": "ruleset", "id": 3, "name": "Evaluate commit message pattern" }, "enforcement": "evaluate", "result": "fail", "rule_type": "commit_message_pattern" } ] }