Skip to content

Commit 017e11c

Browse files
committed
update to latest octokit/openapi
1 parent 4e7b34f commit 017e11c

File tree

4 files changed

+81
-795
lines changed

4 files changed

+81
-795
lines changed
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: List instances of a code scanning alert
3+
example: octokit.rest.codeScanning.listAlertsInstances({ owner, repo, alert_number })
4+
route: GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
5+
scope: codeScanning
6+
type: API method
7+
---
8+
9+
# List instances of a code scanning alert
10+
11+
**Deprecated:** This method has been renamed to codeScanning.listAlertInstances
12+
13+
Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
14+
15+
```js
16+
octokit.rest.codeScanning.listAlertsInstances({
17+
owner,
18+
repo,
19+
alert_number,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>owner</td><td>yes</td><td>
35+
36+
</td></tr>
37+
<tr><td>repo</td><td>yes</td><td>
38+
39+
</td></tr>
40+
<tr><td>alert_number</td><td>yes</td><td>
41+
42+
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
43+
44+
</td></tr>
45+
<tr><td>page</td><td>no</td><td>
46+
47+
Page number of the results to fetch.
48+
49+
</td></tr>
50+
<tr><td>per_page</td><td>no</td><td>
51+
52+
Results per page (max 100).
53+
54+
</td></tr>
55+
<tr><td>ref</td><td>no</td><td>
56+
57+
The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
58+
59+
</td></tr>
60+
</tbody>
61+
</table>
62+
63+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert).

0 commit comments

Comments
 (0)