Skip to content

Commit ff50f18

Browse files
octokitbotoctokitbot
authored
feat: add support for new "List CodeQL databases for a repository" (GET /repos/{owner}/{repo}/code-scanning/codeql/databases) and "Get a CodeQL database for a repository" (GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}) APIs, plus description tweaks (#246)
WIP
1 parent b40d8ef commit ff50f18

File tree

21 files changed

+2022
-493
lines changed

21 files changed

+2022
-493
lines changed

‎cache/api.github.jpy.wang.json

Lines changed: 312 additions & 24 deletions
Large diffs are not rendered by default.

‎cache/ghes-3.2.json

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.12.0",
4+
"version": "7.13.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -8270,7 +8270,7 @@
82708270
},
82718271
{
82728272
"name": "state",
8273-
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
8273+
"description": "Indicates the state of the issues to return.",
82748274
"in": "query",
82758275
"required": false,
82768276
"schema": {
@@ -8288,7 +8288,7 @@
82888288
},
82898289
{
82908290
"name": "sort",
8291-
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
8291+
"description": "What to sort results by.",
82928292
"in": "query",
82938293
"required": false,
82948294
"schema": {
@@ -8547,7 +8547,7 @@
85478547
"type": "string"
85488548
},
85498549
"mode": {
8550-
"description": "The rendering mode. Can be either `markdown` or `gfm`.",
8550+
"description": "The rendering mode.",
85518551
"enum": [
85528552
"markdown",
85538553
"gfm"
@@ -12408,7 +12408,7 @@
1240812408
},
1240912409
{
1241012410
"name": "state",
12411-
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
12411+
"description": "Indicates the state of the issues to return.",
1241212412
"in": "query",
1241312413
"required": false,
1241412414
"schema": {
@@ -12426,7 +12426,7 @@
1242612426
},
1242712427
{
1242812428
"name": "sort",
12429-
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
12429+
"description": "What to sort results by.",
1243012430
"in": "query",
1243112431
"required": false,
1243212432
"schema": {
@@ -13339,7 +13339,7 @@
1333913339
},
1334013340
{
1334113341
"name": "state",
13342-
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
13342+
"description": "Indicates the state of the projects to return.",
1334313343
"in": "query",
1334413344
"required": false,
1334513345
"schema": {
@@ -27447,7 +27447,7 @@
2744727447
},
2744827448
"put": {
2744927449
"summary": "Create or update file contents",
27450-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
27450+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/[email protected]/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
2745127451
"tags": [
2745227452
"repos"
2745327453
],
@@ -27626,7 +27626,7 @@
2762627626
},
2762727627
"delete": {
2762827628
"summary": "Delete a file",
27629-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
27629+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/[email protected]/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
2763027630
"tags": [
2763127631
"repos"
2763227632
],
@@ -29243,7 +29243,7 @@
2924329243
},
2924429244
{
2924529245
"name": "sort",
29246-
"description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
29246+
"description": "The sort order. `stargazers` will sort by star count.",
2924729247
"in": "query",
2924829248
"required": false,
2924929249
"schema": {
@@ -31576,7 +31576,7 @@
3157631576
},
3157731577
{
3157831578
"name": "state",
31579-
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
31579+
"description": "Indicates the state of the issues to return.",
3158031580
"in": "query",
3158131581
"required": false,
3158231582
"schema": {
@@ -31621,7 +31621,7 @@
3162131621
},
3162231622
{
3162331623
"name": "sort",
31624-
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
31624+
"description": "What to sort results by.",
3162531625
"in": "query",
3162631626
"required": false,
3162731627
"schema": {
@@ -36268,7 +36268,7 @@
3626836268
},
3626936269
{
3627036270
"name": "state",
36271-
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
36271+
"description": "Indicates the state of the projects to return.",
3627236272
"in": "query",
3627336273
"required": false,
3627436274
"schema": {
@@ -36493,7 +36493,7 @@
3649336493
},
3649436494
{
3649536495
"name": "sort",
36496-
"description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
36496+
"description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
3649736497
"in": "query",
3649836498
"required": false,
3649936499
"schema": {
@@ -36509,7 +36509,7 @@
3650936509
},
3651036510
{
3651136511
"name": "direction",
36512-
"description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
36512+
"description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
3651336513
"in": "query",
3651436514
"required": false,
3651536515
"schema": {
@@ -36721,7 +36721,7 @@
3672136721
},
3672236722
{
3672336723
"name": "direction",
36724-
"description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
36724+
"description": "The direction to sort results. Ignored without `sort` parameter.",
3672536725
"in": "query",
3672636726
"required": false,
3672736727
"schema": {
@@ -37401,7 +37401,7 @@
3740137401
},
3740237402
{
3740337403
"name": "direction",
37404-
"description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
37404+
"description": "The direction to sort results. Ignored without `sort` parameter.",
3740537405
"in": "query",
3740637406
"required": false,
3740737407
"schema": {
@@ -46946,7 +46946,7 @@
4694646946
},
4694746947
{
4694846948
"name": "state",
46949-
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
46949+
"description": "Indicates the state of the issues to return.",
4695046950
"in": "query",
4695146951
"required": false,
4695246952
"schema": {
@@ -46964,7 +46964,7 @@
4696446964
},
4696546965
{
4696646966
"name": "sort",
46967-
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
46967+
"description": "What to sort results by.",
4696846968
"in": "query",
4696946969
"required": false,
4697046970
"schema": {
@@ -47341,7 +47341,7 @@
4734147341
"parameters": [
4734247342
{
4734347343
"name": "state",
47344-
"description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
47344+
"description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
4734547345
"in": "query",
4734647346
"required": false,
4734747347
"schema": {
@@ -49480,7 +49480,7 @@
4948049480
},
4948149481
{
4948249482
"name": "state",
49483-
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
49483+
"description": "Indicates the state of the projects to return.",
4948449484
"in": "query",
4948549485
"required": false,
4948649486
"schema": {
@@ -60611,7 +60611,16 @@
6061160611
"description": "The outcome of the job.",
6061260612
"example": "success",
6061360613
"type": "string",
60614-
"nullable": true
60614+
"nullable": true,
60615+
"enum": [
60616+
"success",
60617+
"failure",
60618+
"neutral",
60619+
"cancelled",
60620+
"skipped",
60621+
"timed_out",
60622+
"action_required"
60623+
]
6061560624
},
6061660625
"started_at": {
6061760626
"description": "The time that the job started, in ISO 8601 format.",
@@ -71305,7 +71314,7 @@
7130571314
"readOnly": true
7130671315
},
7130771316
"secret-scanning-alert-state": {
71308-
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
71317+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
7130971318
"type": "string",
7131071319
"enum": [
7131171320
"open",
@@ -96045,7 +96054,7 @@
9604596054
}
9604696055
},
9604796056
"code_scanning_forbidden_write": {
96048-
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
96057+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
9604996058
"content": {
9605096059
"application/json": {
9605196060
"schema": {

0 commit comments

Comments
 (0)