:calls: `GET /repos/{owner}/{repo}/code-scanning/alerts `_ :param tool_name: Optional string :param tool_guid: Optional string :param ref: Optional string :par
(
self,
tool_name: Opt[str] = NotSet,
tool_guid: Opt[str] = NotSet,
ref: Opt[str] = NotSet,
pr: Opt[int] = NotSet,
sort: Opt[str] = NotSet,
direction: Opt[str] = NotSet,
state: Opt[str] = NotSet,
severity: Opt[str] = NotSet,
)
| 4277 | return github.Artifact.Artifact(self._requester, headers, data) |
| 4278 | |
| 4279 | def get_codescan_alerts( |
| 4280 | self, |
| 4281 | tool_name: Opt[str] = NotSet, |
| 4282 | tool_guid: Opt[str] = NotSet, |
| 4283 | ref: Opt[str] = NotSet, |
| 4284 | pr: Opt[int] = NotSet, |
| 4285 | sort: Opt[str] = NotSet, |
| 4286 | direction: Opt[str] = NotSet, |
| 4287 | state: Opt[str] = NotSet, |
| 4288 | severity: Opt[str] = NotSet, |
| 4289 | ) -> PaginatedList[CodeScanAlert]: |
| 4290 | """ |
| 4291 | :calls: `GET /repos/{owner}/{repo}/code-scanning/alerts <https://docs.github.com/en/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository>`_ |
| 4292 | :param tool_name: Optional string |
| 4293 | :param tool_guid: Optional string |
| 4294 | :param ref: Optional string |
| 4295 | :param pr: Optional integer |
| 4296 | :param sort: Optional string |
| 4297 | :param direction: Optional string |
| 4298 | :param state: Optional string |
| 4299 | :param severity: Optional string |
| 4300 | :rtype: :class:`PaginatedList` of :class:`github.CodeScanAlert.CodeScanAlert` |
| 4301 | """ |
| 4302 | allowed_sorts = ["created", "updated"] |
| 4303 | allowed_directions = ["asc", "desc"] |
| 4304 | allowed_states = ["open", "closed", "dismissed", "fixed"] |
| 4305 | allowed_severities = ["critical", "high", "medium", "low", "warning", "note", "error"] |
| 4306 | assert is_optional(tool_name, str), tool_name |
| 4307 | assert is_optional(tool_guid, str), tool_guid |
| 4308 | assert ( |
| 4309 | tool_name is NotSet or tool_guid is NotSet |
| 4310 | ), "You can specify the tool by using either tool_guid or tool_name, but not both." |
| 4311 | assert is_optional(ref, str), ref |
| 4312 | assert is_optional(pr, int), pr |
| 4313 | assert sort in allowed_sorts + [NotSet], f"Sort can be one of {', '.join(allowed_sorts)}" |
| 4314 | assert direction in allowed_directions + [NotSet], f"Direction can be one of {', '.join(allowed_directions)}" |
| 4315 | assert state in allowed_states + [NotSet], f"State can be one of {', '.join(allowed_states)}" |
| 4316 | assert severity in allowed_severities + [NotSet], f"Severity can be one of {', '.join(allowed_severities)}" |
| 4317 | url_parameters = NotSet.remove_unset_items( |
| 4318 | { |
| 4319 | "tool_name": tool_name, |
| 4320 | "tool_guid": tool_guid, |
| 4321 | "ref": ref, |
| 4322 | "pr": pr, |
| 4323 | "sort": sort, |
| 4324 | "direction": direction, |
| 4325 | "state": state, |
| 4326 | "severity": severity, |
| 4327 | } |
| 4328 | ) |
| 4329 | return PaginatedList( |
| 4330 | github.CodeScanAlert.CodeScanAlert, |
| 4331 | self._requester, |
| 4332 | f"{self.url}/code-scanning/alerts", |
| 4333 | url_parameters, |
| 4334 | ) |
| 4335 | |
| 4336 | def get_codescan_alert(self, number: int) -> CodeScanAlert: |
no test coverage detected