@octokit/openapi 7.9.1 → 7.12.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 (35) hide show
  1. package/generated/api.github.com.deref.json +2592 -690
  2. package/generated/api.github.com.json +567 -30
  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 +8 -6
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +8 -6
  7. package/generated/ghes-3.2.deref.json +763 -130
  8. package/generated/ghes-3.2.json +53 -10
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +21 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +615 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +25 -1
  12. package/generated/ghes-3.3.deref.json +768 -135
  13. package/generated/ghes-3.3.json +53 -10
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +18 -2
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +18 -2
  16. package/generated/ghes-3.4.deref.json +768 -130
  17. package/generated/ghes-3.4.json +55 -12
  18. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +21 -0
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +753 -132
  22. package/generated/ghes-3.5-diff-to-ghes-3.6.json +32 -6
  23. package/generated/ghes-3.5.deref.json +773 -135
  24. package/generated/ghes-3.5.json +55 -12
  25. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +46 -0
  26. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +141 -20
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +126 -6
  28. package/generated/ghes-3.6.deref.json +1254 -421
  29. package/generated/ghes-3.6.json +160 -23
  30. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +10 -0
  31. package/generated/github.ae-diff-to-api.github.com.deref.json +24 -6
  32. package/generated/github.ae-diff-to-api.github.com.json +24 -6
  33. package/generated/github.ae.deref.json +1019 -290
  34. package/generated/github.ae.json +145 -16
  35. package/package.json +1 -6
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.9.1",
4
+ "version": "7.12.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": {
@@ -3579,7 +3579,7 @@
3579
3579
  "/enterprises/{enterprise}/consumed-licenses": {
3580
3580
  "get": {
3581
3581
  "summary": "List enterprise consumed licenses",
3582
- "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
3582
+ "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
3583
3583
  "tags": [
3584
3584
  "enterprise-admin"
3585
3585
  ],
@@ -6969,7 +6969,7 @@
6969
6969
  },
6970
6970
  "examples": {
6971
6971
  "default": {
6972
- "$ref": "#/components/examples/organization-custom-repository-role-example-old"
6972
+ "$ref": "#/components/examples/organization-custom-repository-role-example"
6973
6973
  }
6974
6974
  }
6975
6975
  }
@@ -10292,6 +10292,305 @@
10292
10292
  "x-octokit": {}
10293
10293
  }
10294
10294
  },
10295
+ "/orgs/{org}/custom_roles": {
10296
+ "post": {
10297
+ "summary": "Create a custom role",
10298
+ "description": "**Note**: This operation is in beta and is subject to change.\n\nCreates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
10299
+ "tags": [
10300
+ "orgs"
10301
+ ],
10302
+ "operationId": "orgs/create-custom-role",
10303
+ "externalDocs": {
10304
+ "description": "API method documentation",
10305
+ "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role"
10306
+ },
10307
+ "parameters": [
10308
+ {
10309
+ "$ref": "#/components/parameters/org"
10310
+ }
10311
+ ],
10312
+ "requestBody": {
10313
+ "required": true,
10314
+ "content": {
10315
+ "application/json": {
10316
+ "schema": {
10317
+ "type": "object",
10318
+ "properties": {
10319
+ "name": {
10320
+ "type": "string",
10321
+ "description": "The name of the custom role."
10322
+ },
10323
+ "description": {
10324
+ "type": "string",
10325
+ "description": "A short description about the intended usage of this role or what permissions it grants."
10326
+ },
10327
+ "base_role": {
10328
+ "type": "string",
10329
+ "enum": [
10330
+ "read",
10331
+ "triage",
10332
+ "write",
10333
+ "maintain"
10334
+ ],
10335
+ "description": "The system role from which this role inherits permissions."
10336
+ },
10337
+ "permissions": {
10338
+ "type": "array",
10339
+ "description": "A list of additional permissions included in this role.",
10340
+ "items": {
10341
+ "type": "string"
10342
+ }
10343
+ }
10344
+ },
10345
+ "required": [
10346
+ "name",
10347
+ "base_role",
10348
+ "permissions"
10349
+ ]
10350
+ },
10351
+ "examples": {
10352
+ "default": {
10353
+ "value": {
10354
+ "name": "Labeler",
10355
+ "description": "A role for issue and PR labelers",
10356
+ "base_role": "read",
10357
+ "permissions": [
10358
+ "add_label"
10359
+ ]
10360
+ }
10361
+ }
10362
+ }
10363
+ }
10364
+ }
10365
+ },
10366
+ "responses": {
10367
+ "201": {
10368
+ "description": "Response",
10369
+ "content": {
10370
+ "application/json": {
10371
+ "schema": {
10372
+ "$ref": "#/components/schemas/organization-custom-repository-role"
10373
+ },
10374
+ "examples": {
10375
+ "default": {
10376
+ "value": {
10377
+ "id": 8030,
10378
+ "name": "Labeler",
10379
+ "description": "A role for issue and PR labelers",
10380
+ "base_role": "read",
10381
+ "permissions": [
10382
+ "add_label"
10383
+ ],
10384
+ "organization": {
10385
+ "login": "github",
10386
+ "id": 9919,
10387
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
10388
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
10389
+ "gravatar_id": "",
10390
+ "url": "https://api.github.com/users/github",
10391
+ "html_url": "https://github.com/github",
10392
+ "followers_url": "https://api.github.com/users/github/followers",
10393
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
10394
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
10395
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
10396
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
10397
+ "organizations_url": "https://api.github.com/users/github/orgs",
10398
+ "repos_url": "https://api.github.com/users/github/repos",
10399
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
10400
+ "received_events_url": "https://api.github.com/users/github/received_events",
10401
+ "type": "Organization",
10402
+ "site_admin": false
10403
+ },
10404
+ "created_at": "2022-07-04T22:19:11Z",
10405
+ "updated_at": "2022-07-04T22:19:11Z"
10406
+ }
10407
+ }
10408
+ }
10409
+ }
10410
+ }
10411
+ },
10412
+ "404": {
10413
+ "$ref": "#/components/responses/not_found"
10414
+ },
10415
+ "422": {
10416
+ "$ref": "#/components/responses/validation_failed"
10417
+ }
10418
+ },
10419
+ "x-github": {
10420
+ "githubCloudOnly": false,
10421
+ "enabledForGitHubApps": true,
10422
+ "category": "orgs",
10423
+ "subcategory": "custom-roles"
10424
+ },
10425
+ "x-octokit": {}
10426
+ }
10427
+ },
10428
+ "/orgs/{org}/custom_roles/{role_id}": {
10429
+ "patch": {
10430
+ "summary": "Update a custom role",
10431
+ "description": "**Note**: This operation is in beta and subject to change.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
10432
+ "tags": [
10433
+ "orgs"
10434
+ ],
10435
+ "operationId": "orgs/update-custom-role",
10436
+ "externalDocs": {
10437
+ "description": "API method documentation",
10438
+ "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role"
10439
+ },
10440
+ "parameters": [
10441
+ {
10442
+ "$ref": "#/components/parameters/org"
10443
+ },
10444
+ {
10445
+ "$ref": "#/components/parameters/role-id"
10446
+ }
10447
+ ],
10448
+ "requestBody": {
10449
+ "required": true,
10450
+ "content": {
10451
+ "application/json": {
10452
+ "schema": {
10453
+ "type": "object",
10454
+ "properties": {
10455
+ "name": {
10456
+ "type": "string",
10457
+ "description": "The name of the custom role."
10458
+ },
10459
+ "description": {
10460
+ "type": "string",
10461
+ "description": "A short description about who this role is for or what permissions it grants."
10462
+ },
10463
+ "base_role": {
10464
+ "type": "string",
10465
+ "enum": [
10466
+ "read",
10467
+ "triage",
10468
+ "write",
10469
+ "maintain"
10470
+ ],
10471
+ "description": "The system role from which this role inherits permissions."
10472
+ },
10473
+ "permissions": {
10474
+ "type": "array",
10475
+ "description": "A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role.",
10476
+ "items": {
10477
+ "type": "string"
10478
+ }
10479
+ }
10480
+ }
10481
+ },
10482
+ "examples": {
10483
+ "default": {
10484
+ "value": {
10485
+ "name": "Labeler",
10486
+ "description": "A role for issue and PR labelers",
10487
+ "base_role": "read",
10488
+ "permissions": [
10489
+ "add_label",
10490
+ "remove_label"
10491
+ ]
10492
+ }
10493
+ }
10494
+ }
10495
+ }
10496
+ }
10497
+ },
10498
+ "responses": {
10499
+ "200": {
10500
+ "description": "Response",
10501
+ "content": {
10502
+ "application/json": {
10503
+ "schema": {
10504
+ "$ref": "#/components/schemas/organization-custom-repository-role"
10505
+ },
10506
+ "examples": {
10507
+ "default": {
10508
+ "value": {
10509
+ "id": 8030,
10510
+ "name": "Labeler",
10511
+ "description": "A role for issue and PR labelers",
10512
+ "base_role": "read",
10513
+ "permissions": [
10514
+ "add_label",
10515
+ "remove_label"
10516
+ ],
10517
+ "organization": {
10518
+ "login": "github",
10519
+ "id": 9919,
10520
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
10521
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
10522
+ "gravatar_id": "",
10523
+ "url": "https://api.github.com/users/github",
10524
+ "html_url": "https://github.com/github",
10525
+ "followers_url": "https://api.github.com/users/github/followers",
10526
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
10527
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
10528
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
10529
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
10530
+ "organizations_url": "https://api.github.com/users/github/orgs",
10531
+ "repos_url": "https://api.github.com/users/github/repos",
10532
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
10533
+ "received_events_url": "https://api.github.com/users/github/received_events",
10534
+ "type": "Organization",
10535
+ "site_admin": false
10536
+ },
10537
+ "created_at": "2022-07-04T22:19:11Z",
10538
+ "updated_at": "2022-07-04T22:19:11Z"
10539
+ }
10540
+ }
10541
+ }
10542
+ }
10543
+ }
10544
+ },
10545
+ "404": {
10546
+ "$ref": "#/components/responses/not_found"
10547
+ },
10548
+ "422": {
10549
+ "$ref": "#/components/responses/validation_failed"
10550
+ }
10551
+ },
10552
+ "x-github": {
10553
+ "githubCloudOnly": false,
10554
+ "enabledForGitHubApps": true,
10555
+ "category": "orgs",
10556
+ "subcategory": "custom-roles"
10557
+ },
10558
+ "x-octokit": {}
10559
+ },
10560
+ "delete": {
10561
+ "summary": "Delete a custom role",
10562
+ "description": "**Note**: This operation is in beta and is subject to change.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
10563
+ "tags": [
10564
+ "orgs"
10565
+ ],
10566
+ "operationId": "orgs/delete-custom-role",
10567
+ "externalDocs": {
10568
+ "description": "API method documentation",
10569
+ "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role"
10570
+ },
10571
+ "parameters": [
10572
+ {
10573
+ "$ref": "#/components/parameters/org"
10574
+ },
10575
+ {
10576
+ "$ref": "#/components/parameters/role-id"
10577
+ }
10578
+ ],
10579
+ "responses": {
10580
+ "204": {
10581
+ "description": "Response"
10582
+ }
10583
+ },
10584
+ "x-github": {
10585
+ "githubCloudOnly": false,
10586
+ "enabledForGitHubApps": true,
10587
+ "previews": [],
10588
+ "category": "orgs",
10589
+ "subcategory": "custom-roles"
10590
+ },
10591
+ "x-octokit": {}
10592
+ }
10593
+ },
10295
10594
  "/orgs/{org}/dependabot/secrets": {
10296
10595
  "get": {
10297
10596
  "summary": "List organization secrets",
@@ -11035,6 +11334,53 @@
11035
11334
  "x-octokit": {}
11036
11335
  }
11037
11336
  },
11337
+ "/orgs/{org}/fine_grained_permissions": {
11338
+ "get": {
11339
+ "summary": "List fine-grained permissions for an organization",
11340
+ "description": "**Note**: This operation is in beta and subject to change.\n\nLists the fine-grained permissions available for an organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.",
11341
+ "tags": [
11342
+ "orgs"
11343
+ ],
11344
+ "operationId": "orgs/list-fine-grained-permissions",
11345
+ "externalDocs": {
11346
+ "description": "API method documentation",
11347
+ "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization"
11348
+ },
11349
+ "parameters": [
11350
+ {
11351
+ "$ref": "#/components/parameters/org"
11352
+ }
11353
+ ],
11354
+ "responses": {
11355
+ "200": {
11356
+ "description": "Response",
11357
+ "content": {
11358
+ "application/json": {
11359
+ "schema": {
11360
+ "type": "array",
11361
+ "items": {
11362
+ "$ref": "#/components/schemas/organization-fine-grained-permission"
11363
+ }
11364
+ },
11365
+ "examples": {
11366
+ "default": {
11367
+ "$ref": "#/components/examples/organization-fine-grained-permission-example"
11368
+ }
11369
+ }
11370
+ }
11371
+ }
11372
+ }
11373
+ },
11374
+ "x-github": {
11375
+ "githubCloudOnly": false,
11376
+ "enabledForGitHubApps": true,
11377
+ "previews": [],
11378
+ "category": "orgs",
11379
+ "subcategory": "custom-roles"
11380
+ },
11381
+ "x-octokit": {}
11382
+ }
11383
+ },
11038
11384
  "/orgs/{org}/hooks": {
11039
11385
  "get": {
11040
11386
  "summary": "List organization webhooks",
@@ -13708,15 +14054,15 @@
13708
14054
  },
13709
14055
  "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
13710
14056
  "get": {
13711
- "summary": "Get all package versions for a package owned by an organization",
13712
- "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
14057
+ "summary": "List package versions for a package owned by an organization",
14058
+ "description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
13713
14059
  "tags": [
13714
14060
  "packages"
13715
14061
  ],
13716
14062
  "operationId": "packages/get-all-package-versions-for-package-owned-by-org",
13717
14063
  "externalDocs": {
13718
14064
  "description": "API method documentation",
13719
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
14065
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
13720
14066
  },
13721
14067
  "parameters": [
13722
14068
  {
@@ -14484,8 +14830,9 @@
14484
14830
  },
14485
14831
  "use_squash_pr_title_as_default": {
14486
14832
  "type": "boolean",
14487
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
14488
- "default": false
14833
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
14834
+ "default": false,
14835
+ "deprecated": true
14489
14836
  },
14490
14837
  "squash_merge_commit_title": {
14491
14838
  "type": "string",
@@ -15322,6 +15669,21 @@
15322
15669
  }
15323
15670
  },
15324
15671
  "responses": {
15672
+ "200": {
15673
+ "description": "Response when the updated information already exists",
15674
+ "content": {
15675
+ "application/json": {
15676
+ "schema": {
15677
+ "$ref": "#/components/schemas/team-full"
15678
+ },
15679
+ "examples": {
15680
+ "default": {
15681
+ "$ref": "#/components/examples/team-full"
15682
+ }
15683
+ }
15684
+ }
15685
+ }
15686
+ },
15325
15687
  "201": {
15326
15688
  "description": "Response",
15327
15689
  "content": {
@@ -15336,6 +15698,15 @@
15336
15698
  }
15337
15699
  }
15338
15700
  }
15701
+ },
15702
+ "403": {
15703
+ "$ref": "#/components/responses/forbidden"
15704
+ },
15705
+ "404": {
15706
+ "$ref": "#/components/responses/not_found"
15707
+ },
15708
+ "422": {
15709
+ "$ref": "#/components/responses/validation_failed"
15339
15710
  }
15340
15711
  },
15341
15712
  "x-github": {
@@ -19395,8 +19766,9 @@
19395
19766
  },
19396
19767
  "use_squash_pr_title_as_default": {
19397
19768
  "type": "boolean",
19398
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
19399
- "default": false
19769
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
19770
+ "default": false,
19771
+ "deprecated": true
19400
19772
  },
19401
19773
  "squash_merge_commit_title": {
19402
19774
  "type": "string",
@@ -22915,7 +23287,7 @@
22915
23287
  },
22916
23288
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
22917
23289
  "get": {
22918
- "summary": "List workflow runs",
23290
+ "summary": "List workflow runs for a workflow",
22919
23291
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
22920
23292
  "tags": [
22921
23293
  "actions"
@@ -29067,6 +29439,22 @@
29067
29439
  "default": "all"
29068
29440
  }
29069
29441
  },
29442
+ {
29443
+ "name": "permission",
29444
+ "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
29445
+ "in": "query",
29446
+ "required": false,
29447
+ "schema": {
29448
+ "type": "string",
29449
+ "enum": [
29450
+ "pull",
29451
+ "triage",
29452
+ "push",
29453
+ "maintain",
29454
+ "admin"
29455
+ ]
29456
+ }
29457
+ },
29070
29458
  {
29071
29459
  "$ref": "#/components/parameters/per-page"
29072
29460
  },
@@ -30652,6 +31040,7 @@
30652
31040
  "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
30653
31041
  "in": "path",
30654
31042
  "required": true,
31043
+ "x-multi-segment": true,
30655
31044
  "schema": {
30656
31045
  "type": "string"
30657
31046
  }
@@ -30793,7 +31182,7 @@
30793
31182
  },
30794
31183
  "put": {
30795
31184
  "summary": "Create or update file contents",
30796
- "description": "Creates a new file or replaces an existing file in a repository.",
31185
+ "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.",
30797
31186
  "tags": [
30798
31187
  "repos"
30799
31188
  ],
@@ -31012,7 +31401,7 @@
31012
31401
  },
31013
31402
  "sha": {
31014
31403
  "type": "string",
31015
- "description": "The blob SHA of the file being replaced."
31404
+ "description": "The blob SHA of the file being deleted."
31016
31405
  },
31017
31406
  "branch": {
31018
31407
  "type": "string",
@@ -34147,7 +34536,7 @@
34147
34536
  "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
34148
34537
  "get": {
34149
34538
  "summary": "Get a tree",
34150
- "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
34539
+ "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
34151
34540
  "tags": [
34152
34541
  "git"
34153
34542
  ],
@@ -34220,7 +34609,7 @@
34220
34609
  "/repos/{owner}/{repo}/hooks": {
34221
34610
  "get": {
34222
34611
  "summary": "List repository webhooks",
34223
- "description": "",
34612
+ "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
34224
34613
  "tags": [
34225
34614
  "repos"
34226
34615
  ],
@@ -56051,15 +56440,15 @@
56051
56440
  },
56052
56441
  "/user/packages/{package_type}/{package_name}/versions": {
56053
56442
  "get": {
56054
- "summary": "Get all package versions for a package owned by the authenticated user",
56055
- "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
56443
+ "summary": "List package versions for a package owned by the authenticated user",
56444
+ "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
56056
56445
  "tags": [
56057
56446
  "packages"
56058
56447
  ],
56059
56448
  "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
56060
56449
  "externalDocs": {
56061
56450
  "description": "API method documentation",
56062
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
56451
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
56063
56452
  },
56064
56453
  "parameters": [
56065
56454
  {
@@ -57047,7 +57436,7 @@
57047
57436
  "key": {
57048
57437
  "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"",
57049
57438
  "type": "string",
57050
- "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
57439
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
57051
57440
  }
57052
57441
  },
57053
57442
  "required": [
@@ -58547,15 +58936,15 @@
58547
58936
  },
58548
58937
  "/users/{username}/packages/{package_type}/{package_name}/versions": {
58549
58938
  "get": {
58550
- "summary": "Get all package versions for a package owned by a user",
58551
- "description": "Returns all package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
58939
+ "summary": "List package versions for a package owned by a user",
58940
+ "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
58552
58941
  "tags": [
58553
58942
  "packages"
58554
58943
  ],
58555
58944
  "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
58556
58945
  "externalDocs": {
58557
58946
  "description": "API method documentation",
58558
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58947
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58559
58948
  },
58560
58949
  "parameters": [
58561
58950
  {
@@ -61660,8 +62049,9 @@
61660
62049
  },
61661
62050
  "use_squash_pr_title_as_default": {
61662
62051
  "type": "boolean",
61663
- "description": "Whether a squash merge commit can use the pull request title as default.",
61664
- "default": false
62052
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
62053
+ "default": false,
62054
+ "deprecated": true
61665
62055
  },
61666
62056
  "squash_merge_commit_title": {
61667
62057
  "type": "string",
@@ -63475,7 +63865,15 @@
63475
63865
  },
63476
63866
  "github_com_enterprise_role": {
63477
63867
  "type": "string",
63478
- "nullable": true
63868
+ "nullable": true,
63869
+ "description": "Deprecated: The most permissive enterprise role for a user."
63870
+ },
63871
+ "github_com_enterprise_roles": {
63872
+ "type": "array",
63873
+ "description": "All enterprise roles for a user.",
63874
+ "items": {
63875
+ "type": "string"
63876
+ }
63479
63877
  },
63480
63878
  "visual_studio_subscription_user": {
63481
63879
  "type": "boolean"
@@ -66618,8 +67016,9 @@
66618
67016
  },
66619
67017
  "use_squash_pr_title_as_default": {
66620
67018
  "type": "boolean",
66621
- "description": "Whether a squash merge commit can use the pull request title as default.",
66622
- "default": false
67019
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
67020
+ "default": false,
67021
+ "deprecated": true
66623
67022
  },
66624
67023
  "squash_merge_commit_title": {
66625
67024
  "type": "string",
@@ -67323,6 +67722,39 @@
67323
67722
  "name": {
67324
67723
  "description": "The name of the custom role.",
67325
67724
  "type": "string"
67725
+ },
67726
+ "description": {
67727
+ "description": "A short description about who this role is for or what permissions it grants.",
67728
+ "type": "string",
67729
+ "nullable": true
67730
+ },
67731
+ "base_role": {
67732
+ "type": "string",
67733
+ "description": "The system role from which this role inherits permissions.",
67734
+ "enum": [
67735
+ "read",
67736
+ "triage",
67737
+ "write",
67738
+ "maintain"
67739
+ ]
67740
+ },
67741
+ "permissions": {
67742
+ "description": "A list of additional permissions included in this role.",
67743
+ "type": "array",
67744
+ "items": {
67745
+ "type": "string"
67746
+ }
67747
+ },
67748
+ "organization": {
67749
+ "$ref": "#/components/schemas/simple-user"
67750
+ },
67751
+ "created_at": {
67752
+ "type": "string",
67753
+ "format": "date-time"
67754
+ },
67755
+ "updated_at": {
67756
+ "type": "string",
67757
+ "format": "date-time"
67326
67758
  }
67327
67759
  },
67328
67760
  "required": [
@@ -68506,6 +68938,23 @@
68506
68938
  "node_id"
68507
68939
  ]
68508
68940
  },
68941
+ "organization-fine-grained-permission": {
68942
+ "title": "Organization Fine-Grained Permission",
68943
+ "description": "Fine-grained permissions available for the organization",
68944
+ "type": "object",
68945
+ "properties": {
68946
+ "name": {
68947
+ "type": "string"
68948
+ },
68949
+ "description": {
68950
+ "type": "string"
68951
+ }
68952
+ },
68953
+ "required": [
68954
+ "name",
68955
+ "description"
68956
+ ]
68957
+ },
68509
68958
  "org-hook": {
68510
68959
  "title": "Org Hook",
68511
68960
  "description": "Org Hook",
@@ -90309,6 +90758,9 @@
90309
90758
  "org2:Owner"
90310
90759
  ],
90311
90760
  "github_com_enterprise_role": "owner",
90761
+ "github_com_enterprise_roles": [
90762
+ "owner"
90763
+ ],
90312
90764
  "visual_studio_subscription_user": false,
90313
90765
  "github_com_verified_domain_emails": [
90314
90766
  "monalisa@github.com"
@@ -90337,6 +90789,7 @@
90337
90789
  "license_type": "enterprise",
90338
90790
  "github_com_member_roles": [],
90339
90791
  "github_com_enterprise_role": "",
90792
+ "github_com_enterprise_roles": [],
90340
90793
  "visual_studio_subscription_user": false,
90341
90794
  "github_com_verified_domain_emails": [],
90342
90795
  "github_com_saml_name_id": "",
@@ -91963,17 +92416,76 @@
91963
92416
  }
91964
92417
  ]
91965
92418
  },
91966
- "organization-custom-repository-role-example-old": {
92419
+ "organization-custom-repository-role-example": {
91967
92420
  "value": {
91968
92421
  "total_count": 2,
91969
92422
  "custom_roles": [
91970
92423
  {
91971
92424
  "id": 8030,
91972
- "name": "Developer"
92425
+ "name": "Security Engineer",
92426
+ "description": "Able to contribute code and maintain the security pipeline",
92427
+ "base_role": "maintain",
92428
+ "permissions": [
92429
+ "delete_alerts_code_scanning"
92430
+ ],
92431
+ "organization": {
92432
+ "login": "github",
92433
+ "id": 9919,
92434
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92435
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92436
+ "gravatar_id": "",
92437
+ "url": "https://api.github.com/users/github",
92438
+ "html_url": "https://github.com/github",
92439
+ "followers_url": "https://api.github.com/users/github/followers",
92440
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92441
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92442
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92443
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92444
+ "organizations_url": "https://api.github.com/users/github/orgs",
92445
+ "repos_url": "https://api.github.com/users/github/repos",
92446
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92447
+ "received_events_url": "https://api.github.com/users/github/received_events",
92448
+ "type": "Organization",
92449
+ "site_admin": false
92450
+ },
92451
+ "created_at": "2022-07-04T22:19:11Z",
92452
+ "updated_at": "2022-07-04T22:20:11Z"
91973
92453
  },
91974
92454
  {
91975
92455
  "id": 8031,
91976
- "name": "Designer"
92456
+ "name": "Community manager",
92457
+ "description": "Able to handle all the community interactions without being able to contribute code",
92458
+ "base_role": "read",
92459
+ "permissions": [
92460
+ "mark_as_duplicate",
92461
+ "manage_settings_pages",
92462
+ "manage_settings_wiki",
92463
+ "set_social_preview",
92464
+ "edit_repo_metadata",
92465
+ "toggle_discussion_comment_minimize"
92466
+ ],
92467
+ "organization": {
92468
+ "login": "github",
92469
+ "id": 9919,
92470
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92471
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92472
+ "gravatar_id": "",
92473
+ "url": "https://api.github.com/users/github",
92474
+ "html_url": "https://github.com/github",
92475
+ "followers_url": "https://api.github.com/users/github/followers",
92476
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92477
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92478
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92479
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92480
+ "organizations_url": "https://api.github.com/users/github/orgs",
92481
+ "repos_url": "https://api.github.com/users/github/repos",
92482
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92483
+ "received_events_url": "https://api.github.com/users/github/received_events",
92484
+ "type": "Organization",
92485
+ "site_admin": false
92486
+ },
92487
+ "created_at": "2022-07-05T12:01:11Z",
92488
+ "updated_at": "2022-07-05T12:20:11Z"
91977
92489
  }
91978
92490
  ]
91979
92491
  }
@@ -93375,6 +93887,22 @@
93375
93887
  }
93376
93888
  ]
93377
93889
  },
93890
+ "organization-fine-grained-permission-example": {
93891
+ "value": [
93892
+ {
93893
+ "name": "add_assignee",
93894
+ "description": "Assign or remove a user"
93895
+ },
93896
+ {
93897
+ "name": "remove_assignee",
93898
+ "description": "Remove an assigned user"
93899
+ },
93900
+ {
93901
+ "name": "add_label",
93902
+ "description": "Add or remove a label"
93903
+ }
93904
+ ]
93905
+ },
93378
93906
  "org-hook-items": {
93379
93907
  "value": [
93380
93908
  {
@@ -112948,6 +113476,15 @@
112948
113476
  "type": "string"
112949
113477
  }
112950
113478
  },
113479
+ "role-id": {
113480
+ "name": "role_id",
113481
+ "description": "The unique identifier of the role.",
113482
+ "in": "path",
113483
+ "required": true,
113484
+ "schema": {
113485
+ "type": "integer"
113486
+ }
113487
+ },
112951
113488
  "group-id": {
112952
113489
  "name": "group_id",
112953
113490
  "description": "The unique identifier of the group.",