Конечные точки REST API для наборов правил

List organization rule suites

Lists suites of rule evaluations at the organization level. For more information, see "Managing rulesets for repositories in your organization."

Подробные маркеры доступа для "List organization rule suites

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" organization permissions (write)

Параметры для "List organization rule suites"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`ref` string The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.
`repository_name` integer The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.
`time_period` string The time period to filter by. For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). По умолчанию.: `day` Возможные значения: `hour`, `day`, `week`, `month`
`actor_name` string The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
`rule_suite_result` string The rule results to filter on. When specified, only suites with this result will be returned. По умолчанию.: `all` Возможные значения: `pass`, `fail`, `bypass`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

Коды состояния http-ответа для "List organization rule suites"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

Примеры кода для "List organization rule suites"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/orgs/{org}/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/orgs/ORG/rulesets/rule-suites

Response

Status: 200

[
  {
    "id": 21,
    "actor_id": 12,
    "actor_name": "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,
    "actor_name": "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"
  }
]

Get an organization rule suite

Gets information about a suite of rule evaluations from within an organization. For more information, see "Managing rulesets for repositories in your organization."

Подробные маркеры доступа для "Get an organization rule suite

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" organization permissions (write)

Параметры для "Get an organization rule suite"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`rule_suite_id` integer Обязательное поле The unique identifier of the rule suite result. To get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites for repositories and GET /orgs/{org}/rulesets/rule-suites for organizations.

Коды состояния http-ответа для "Get an organization rule suite"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

Примеры кода для "Get an organization rule suite"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/orgs/{org}/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/orgs/ORG/rulesets/rule-suites/RULE_SUITE_ID

Response

Status: 200

{
  "id": 21,
  "actor_id": 12,
  "actor_name": "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"
    }
  ]
}