code_scanning_list_alerts - Charter Docs

GET

github_code_scanning_list_alerts.py

import asyncio

from charter.packs import github

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

Requires security_events or repo. With github.APP or github.FINE_GRAINED, requires security_events=read or security_events=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.

Query parameters

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`
`toolName`	`string`	The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.
`toolGuid`	`string`	The GUID of a code scanning tool. Note that some code scanning tools may not include a GUID in their analysis data. Cannot be combined with `tool_name`.
`ref`	`string`	The Git reference for the results you want to list. A branch can be `refs/heads/BRANCH` or simply `BRANCH`. To reference a pull request use `refs/pull/NUMBER/merge`.
`pr`	`integer`	The number of the pull request for the results you want to list.
`state`	CodeScanningState	If specified, only code scanning alerts with this state will be returned.
`severity`	CodeScanningSeverity	If specified, only code scanning alerts with this severity will be returned.
`assignees`	`string`	Filter alerts by assignees, as a comma-separated list of user handles. Use `*` for at least one assignee or `none` for unassigned.
`sort`	CodeScanningSort	The property by which to sort the results. GitHub uses `created` when this is absent.
`direction`	SortDirection	The direction to sort the results by. GitHub uses `desc` when this is absent.