GET
github_checks_list_suites_for_ref.py
Requires
repo, read:user. Pages by number: page with per_page.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
List the check suites for a commit, branch or tag — one suite per app that reported. Coarser than checks_list_for_ref, and the way past its 1,000-suite ceiling on a very busy reference.
from charter.packs import github
result = await github.checks_list_suites_for_ref.ainvoke({"owner": ..., "repo": ..., "ref": ...})
repo, read:user. Pages by number: page with per_page.| Field | Type | Description |
|---|---|---|
owner * | string | The account owner of the repository. The name is not case sensitive. |
repo * | string | The name of the repository without the .git extension. The name is not case sensitive. |
ref * | string | The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). |
| Field | Type | Description |
|---|---|---|
perPage | integer | The number of results per page (max 100). Defaults to 30. ≥ 1; ≤ 100; defaults to 30 |
page | integer | The page number of the results to fetch. Defaults to 1. ≥ 1; defaults to 1 |
appId | integer | Filters check suites by GitHub App id. |
checkName | string | Returns check runs with the specified name. |
Was this page helpful?