checks_list_for_ref - Charter Docs

GET

github_checks_list_for_ref.py

import asyncio

from charter.packs import github

result = asyncio.run(github.checks_list_for_ref.ainvoke({"owner": ..., "repo": ..., "ref": ...}))

Requires repo. With github.APP or github.FINE_GRAINED, requires checks=read or checks=write. Pages by number: page with per_page.

Path parameters

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`
`checkName`	`string`	Returns check runs with the specified `name`.
`status`	CheckRunStatusFilter	Returns check runs with the specified `status`. This filter takes a status only — a failed run is `status: completed` with a `conclusion` of `failure` on the way back.
`filter`	JobFilter	Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. GitHub uses `latest` when this is absent.
`appId`	`integer`	Only check runs reported by this GitHub App. GitHub Actions is itself an App, so this is how a repository with several CI providers is narrowed to one.