@octokit/openapi 6.3.1 → 6.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/generated/api.github.com.deref.json +66 -6
  2. package/generated/api.github.com.json +69 -6
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +50 -3
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +53 -3
  7. package/generated/ghes-3.2.deref.json +59 -3
  8. package/generated/ghes-3.2.json +62 -3
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +8 -4
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  12. package/generated/ghes-3.3.deref.json +59 -3
  13. package/generated/ghes-3.3.json +62 -3
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  16. package/generated/ghes-3.4.deref.json +71 -7
  17. package/generated/ghes-3.4.json +66 -7
  18. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +11086 -112673
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -574
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -263
  21. package/generated/ghes-3.5.deref.json +2642 -294
  22. package/generated/ghes-3.5.json +3173 -606
  23. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +14 -3
  24. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -1
  25. package/generated/github.ae-diff-to-api.github.com.json +1 -1
  26. package/generated/github.ae.deref.json +3813 -314
  27. package/generated/github.ae.json +4250 -556
  28. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.3.1",
4
+ "version": "6.4.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -5963,83 +5963,6 @@
5963
5963
  }
5964
5964
  }
5965
5965
  },
5966
- "/repos/{owner}/{repo}/code-scanning/alerts": {
5967
- "get": {
5968
- "summary": "List code scanning alerts for a repository",
5969
- "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).",
5970
- "tags": ["code-scanning"],
5971
- "operationId": "code-scanning/list-alerts-for-repo",
5972
- "externalDocs": {
5973
- "description": "API method documentation",
5974
- "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
5975
- },
5976
- "parameters": [
5977
- { "$ref": "#/components/parameters/owner" },
5978
- { "$ref": "#/components/parameters/repo" },
5979
- { "$ref": "#/components/parameters/tool-name" },
5980
- { "$ref": "#/components/parameters/tool-guid" },
5981
- { "$ref": "#/components/parameters/page" },
5982
- { "$ref": "#/components/parameters/per-page" },
5983
- { "$ref": "#/components/parameters/git-ref" },
5984
- { "$ref": "#/components/parameters/direction" },
5985
- {
5986
- "name": "sort",
5987
- "description": "The property by which to sort the results.",
5988
- "in": "query",
5989
- "required": false,
5990
- "schema": {
5991
- "type": "string",
5992
- "enum": ["created", "updated", "number"],
5993
- "default": "number"
5994
- }
5995
- },
5996
- {
5997
- "name": "state",
5998
- "description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
5999
- "in": "query",
6000
- "required": false,
6001
- "schema": {
6002
- "$ref": "#/components/schemas/code-scanning-alert-state"
6003
- }
6004
- }
6005
- ],
6006
- "responses": {
6007
- "200": {
6008
- "description": "Response",
6009
- "content": {
6010
- "application/json": {
6011
- "schema": {
6012
- "type": "array",
6013
- "items": {
6014
- "$ref": "#/components/schemas/code-scanning-alert-items"
6015
- }
6016
- },
6017
- "examples": {
6018
- "default": {
6019
- "$ref": "#/components/examples/code-scanning-alert-items"
6020
- }
6021
- }
6022
- }
6023
- }
6024
- },
6025
- "304": { "$ref": "#/components/responses/not_modified" },
6026
- "403": {
6027
- "$ref": "#/components/responses/code_scanning_forbidden_read"
6028
- },
6029
- "404": { "$ref": "#/components/responses/not_found" },
6030
- "503": { "$ref": "#/components/responses/service_unavailable" }
6031
- },
6032
- "x-github": {
6033
- "githubCloudOnly": false,
6034
- "enabledForGitHubApps": true,
6035
- "category": "code-scanning",
6036
- "subcategory": null
6037
- },
6038
- "x-octokit": {
6039
- "diff": { "api.github.com.json": { "type": "changed" } }
6040
- }
6041
- }
6042
- },
6043
5966
  "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
6044
5967
  "get": {
6045
5968
  "summary": "Get a code scanning alert",
@@ -11351,13 +11274,6 @@
11351
11274
  "required": true,
11352
11275
  "schema": { "type": "integer" }
11353
11276
  },
11354
- "git-ref": {
11355
- "name": "ref",
11356
- "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`.",
11357
- "in": "query",
11358
- "required": false,
11359
- "schema": { "$ref": "#/components/schemas/code-scanning-ref" }
11360
- },
11361
11277
  "alert-number": {
11362
11278
  "name": "alert_number",
11363
11279
  "in": "path",
@@ -15422,55 +15338,6 @@
15422
15338
  "repository": { "$ref": "#/components/schemas/minimal-repository" }
15423
15339
  }
15424
15340
  },
15425
- "code-scanning-alert-items": {
15426
- "type": "object",
15427
- "properties": {
15428
- "number": { "$ref": "#/components/schemas/alert-number" },
15429
- "created_at": { "$ref": "#/components/schemas/alert-created-at" },
15430
- "updated_at": { "$ref": "#/components/schemas/alert-updated-at" },
15431
- "url": { "$ref": "#/components/schemas/alert-url" },
15432
- "html_url": { "$ref": "#/components/schemas/alert-html-url" },
15433
- "instances_url": {
15434
- "$ref": "#/components/schemas/alert-instances-url"
15435
- },
15436
- "state": { "$ref": "#/components/schemas/code-scanning-alert-state" },
15437
- "fixed_at": {
15438
- "$ref": "#/components/schemas/code-scanning-alert-fixed-at"
15439
- },
15440
- "dismissed_by": {
15441
- "$ref": "#/components/schemas/nullable-simple-user"
15442
- },
15443
- "dismissed_at": {
15444
- "$ref": "#/components/schemas/code-scanning-alert-dismissed-at"
15445
- },
15446
- "dismissed_reason": {
15447
- "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
15448
- },
15449
- "rule": {
15450
- "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
15451
- },
15452
- "tool": {
15453
- "$ref": "#/components/schemas/code-scanning-analysis-tool"
15454
- },
15455
- "most_recent_instance": {
15456
- "$ref": "#/components/schemas/code-scanning-alert-instance"
15457
- }
15458
- },
15459
- "required": [
15460
- "number",
15461
- "created_at",
15462
- "url",
15463
- "html_url",
15464
- "instances_url",
15465
- "state",
15466
- "dismissed_by",
15467
- "dismissed_at",
15468
- "dismissed_reason",
15469
- "rule",
15470
- "tool",
15471
- "most_recent_instance"
15472
- ]
15473
- },
15474
15341
  "code-scanning-alert": {
15475
15342
  "type": "object",
15476
15343
  "properties": {
@@ -18538,36 +18405,6 @@
18538
18405
  "committer"
18539
18406
  ]
18540
18407
  },
18541
- "code-scanning-alert-rule-summary": {
18542
- "type": "object",
18543
- "properties": {
18544
- "id": {
18545
- "nullable": true,
18546
- "type": "string",
18547
- "description": "A unique identifier for the rule used to detect the alert."
18548
- },
18549
- "name": {
18550
- "type": "string",
18551
- "description": "The name of the rule used to detect the alert."
18552
- },
18553
- "tags": {
18554
- "nullable": true,
18555
- "type": "array",
18556
- "description": "A set of tags applicable for the rule.",
18557
- "items": { "type": "string" }
18558
- },
18559
- "severity": {
18560
- "nullable": true,
18561
- "type": "string",
18562
- "description": "The severity of the alert.",
18563
- "enum": ["none", "note", "warning", "error"]
18564
- },
18565
- "description": {
18566
- "type": "string",
18567
- "description": "A short description of the rule used to detect the alert."
18568
- }
18569
- }
18570
- },
18571
18408
  "nullable-collaborator": {
18572
18409
  "title": "Collaborator",
18573
18410
  "description": "Collaborator",
@@ -24496,105 +24333,6 @@
24496
24333
  }
24497
24334
  }
24498
24335
  },
24499
- "code-scanning-alert-items": {
24500
- "value": [
24501
- {
24502
- "number": 4,
24503
- "created_at": "2020-02-13T12:29:18Z",
24504
- "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
24505
- "html_url": "https://github.com/octocat/hello-world/code-scanning/4",
24506
- "state": "open",
24507
- "fixed_at": null,
24508
- "dismissed_by": null,
24509
- "dismissed_at": null,
24510
- "dismissed_reason": null,
24511
- "rule": {
24512
- "id": "js/zipslip",
24513
- "severity": "error",
24514
- "tags": ["security", "external/cwe/cwe-022"],
24515
- "description": "Arbitrary file write during zip extraction",
24516
- "name": "js/zipslip"
24517
- },
24518
- "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
24519
- "most_recent_instance": {
24520
- "ref": "refs/heads/main",
24521
- "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
24522
- "environment": "{}",
24523
- "state": "open",
24524
- "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
24525
- "message": {
24526
- "text": "This path depends on a user-provided value."
24527
- },
24528
- "location": {
24529
- "path": "spec-main/api-session-spec.ts",
24530
- "start_line": 917,
24531
- "end_line": 917,
24532
- "start_column": 7,
24533
- "end_column": 18
24534
- },
24535
- "classifications": ["test"]
24536
- },
24537
- "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances"
24538
- },
24539
- {
24540
- "number": 3,
24541
- "created_at": "2020-02-13T12:29:18Z",
24542
- "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
24543
- "html_url": "https://github.com/octocat/hello-world/code-scanning/3",
24544
- "state": "dismissed",
24545
- "fixed_at": null,
24546
- "dismissed_by": {
24547
- "login": "octocat",
24548
- "id": 1,
24549
- "node_id": "MDQ6VXNlcjE=",
24550
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
24551
- "gravatar_id": "",
24552
- "url": "https://api.github.com/users/octocat",
24553
- "html_url": "https://github.com/octocat",
24554
- "followers_url": "https://api.github.com/users/octocat/followers",
24555
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
24556
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
24557
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24558
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
24559
- "organizations_url": "https://api.github.com/users/octocat/orgs",
24560
- "repos_url": "https://api.github.com/users/octocat/repos",
24561
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
24562
- "received_events_url": "https://api.github.com/users/octocat/received_events",
24563
- "type": "User",
24564
- "site_admin": false
24565
- },
24566
- "dismissed_at": "2020-02-14T12:29:18Z",
24567
- "dismissed_reason": "false positive",
24568
- "rule": {
24569
- "id": "js/zipslip",
24570
- "severity": "error",
24571
- "tags": ["security", "external/cwe/cwe-022"],
24572
- "description": "Arbitrary file write during zip extraction",
24573
- "name": "js/zipslip"
24574
- },
24575
- "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
24576
- "most_recent_instance": {
24577
- "ref": "refs/heads/main",
24578
- "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
24579
- "environment": "{}",
24580
- "state": "open",
24581
- "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
24582
- "message": {
24583
- "text": "This path depends on a user-provided value."
24584
- },
24585
- "location": {
24586
- "path": "lib/ab12-gen.js",
24587
- "start_line": 917,
24588
- "end_line": 917,
24589
- "start_column": 7,
24590
- "end_column": 18
24591
- },
24592
- "classifications": []
24593
- },
24594
- "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances"
24595
- }
24596
- ]
24597
- },
24598
24336
  "code-scanning-alert": {
24599
24337
  "value": {
24600
24338
  "number": 42,