Skip to content

Commit 2b16a17

Browse files
committed
WIP octokit/openapi updated
1 parent c9c561f commit 2b16a17

File tree

2 files changed

+120
-0
lines changed

2 files changed

+120
-0
lines changed

scripts/update-endpoints/generated/endpoints.json

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11597,6 +11597,118 @@
1159711597
],
1159811598
"renamed": null
1159911599
},
11600+
{
11601+
"name": "List code scanning alerts for a repository",
11602+
"scope": "codeScanning",
11603+
"id": "listAlertInstances",
11604+
"method": "GET",
11605+
"url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
11606+
"isDeprecated": false,
11607+
"deprecationDate": null,
11608+
"description": "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.",
11609+
"documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert",
11610+
"previews": [],
11611+
"headers": [],
11612+
"parameters": [
11613+
{
11614+
"name": "owner",
11615+
"description": "",
11616+
"in": "PATH",
11617+
"type": "string",
11618+
"required": true,
11619+
"enum": null,
11620+
"allowNull": false,
11621+
"mapToData": null,
11622+
"validation": null,
11623+
"alias": null,
11624+
"deprecated": null
11625+
},
11626+
{
11627+
"name": "repo",
11628+
"description": "",
11629+
"in": "PATH",
11630+
"type": "string",
11631+
"required": true,
11632+
"enum": null,
11633+
"allowNull": false,
11634+
"mapToData": null,
11635+
"validation": null,
11636+
"alias": null,
11637+
"deprecated": null
11638+
},
11639+
{
11640+
"name": "alert_number",
11641+
"description": "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.",
11642+
"in": "PATH",
11643+
"type": "integer",
11644+
"required": true,
11645+
"enum": null,
11646+
"allowNull": false,
11647+
"mapToData": null,
11648+
"validation": null,
11649+
"alias": null,
11650+
"deprecated": null
11651+
},
11652+
{
11653+
"name": "page",
11654+
"description": "Page number of the results to fetch.",
11655+
"in": "QUERY",
11656+
"type": "integer",
11657+
"required": false,
11658+
"enum": null,
11659+
"allowNull": false,
11660+
"mapToData": null,
11661+
"validation": null,
11662+
"alias": null,
11663+
"deprecated": null
11664+
},
11665+
{
11666+
"name": "per_page",
11667+
"description": "Results per page (max 100).",
11668+
"in": "QUERY",
11669+
"type": "integer",
11670+
"required": false,
11671+
"enum": null,
11672+
"allowNull": false,
11673+
"mapToData": null,
11674+
"validation": null,
11675+
"alias": null,
11676+
"deprecated": null
11677+
},
11678+
{
11679+
"name": "ref",
11680+
"description": "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`.",
11681+
"in": "QUERY",
11682+
"type": "string",
11683+
"required": false,
11684+
"enum": null,
11685+
"allowNull": false,
11686+
"mapToData": null,
11687+
"validation": null,
11688+
"alias": null,
11689+
"deprecated": null
11690+
}
11691+
],
11692+
"responses": [
11693+
{
11694+
"code": 200,
11695+
"description": "Response",
11696+
"examples": [
11697+
{
11698+
"data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]"
11699+
}
11700+
]
11701+
},
11702+
{
11703+
"code": 403,
11704+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
11705+
"examples": null
11706+
},
11707+
{ "code": 404, "description": "Resource not found", "examples": null },
11708+
{ "code": 503, "description": "Service unavailable", "examples": null }
11709+
],
11710+
"renamed": null
11711+
},
1160011712
{
1160111713
"name": "List code scanning alerts for a repository",
1160211714
"scope": "codeScanning",

src/generated/parameters-and-response-types.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,6 +1276,14 @@ export type RestEndpointMethodTypes = {
12761276
>;
12771277
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"];
12781278
};
1279+
listAlertsForRepo: {
1280+
parameters: RequestParameters &
1281+
Omit<
1282+
Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["parameters"],
1283+
"baseUrl" | "headers" | "mediaType"
1284+
>;
1285+
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"];
1286+
};
12791287
listAlertsForRepo: {
12801288
parameters: RequestParameters &
12811289
Omit<

0 commit comments

Comments
 (0)