@octokit/openapi 7.8.0 → 7.10.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 (33) hide show
  1. package/generated/api.github.com.deref.json +1921 -538
  2. package/generated/api.github.com.json +544 -29
  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 +127 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -8
  7. package/generated/ghes-3.2.deref.json +134 -27
  8. package/generated/ghes-3.2.json +26 -9
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +134 -27
  12. package/generated/ghes-3.3.json +26 -9
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +2 -2
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +2 -2
  15. package/generated/ghes-3.4.deref.json +134 -27
  16. package/generated/ghes-3.4.json +28 -11
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +127 -25
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +25 -8
  21. package/generated/ghes-3.5.deref.json +134 -27
  22. package/generated/ghes-3.5.json +28 -11
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +82 -0
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +9648 -479
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +1020 -23
  26. package/generated/ghes-3.6.deref.json +544 -234
  27. package/generated/ghes-3.6.json +147 -24
  28. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +30 -0
  29. package/generated/github.ae-diff-to-api.github.com.deref.json +91 -19
  30. package/generated/github.ae-diff-to-api.github.com.json +25 -8
  31. package/generated/github.ae.deref.json +190 -27
  32. package/generated/github.ae.json +118 -15
  33. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.8.0",
4
+ "version": "7.10.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": {
@@ -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",
@@ -19395,8 +19742,9 @@
19395
19742
  },
19396
19743
  "use_squash_pr_title_as_default": {
19397
19744
  "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
19745
+ "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.",
19746
+ "default": false,
19747
+ "deprecated": true
19400
19748
  },
19401
19749
  "squash_merge_commit_title": {
19402
19750
  "type": "string",
@@ -21282,6 +21630,9 @@
21282
21630
  },
21283
21631
  {
21284
21632
  "$ref": "#/components/parameters/workflow-run-check-suite-id"
21633
+ },
21634
+ {
21635
+ "$ref": "#/components/parameters/workflow-run-head-sha"
21285
21636
  }
21286
21637
  ],
21287
21638
  "responses": {
@@ -22912,7 +23263,7 @@
22912
23263
  },
22913
23264
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
22914
23265
  "get": {
22915
- "summary": "List workflow runs",
23266
+ "summary": "List workflow runs for a workflow",
22916
23267
  "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.",
22917
23268
  "tags": [
22918
23269
  "actions"
@@ -22958,6 +23309,9 @@
22958
23309
  },
22959
23310
  {
22960
23311
  "$ref": "#/components/parameters/workflow-run-check-suite-id"
23312
+ },
23313
+ {
23314
+ "$ref": "#/components/parameters/workflow-run-head-sha"
22961
23315
  }
22962
23316
  ],
22963
23317
  "responses": {
@@ -31006,7 +31360,7 @@
31006
31360
  },
31007
31361
  "sha": {
31008
31362
  "type": "string",
31009
- "description": "The blob SHA of the file being replaced."
31363
+ "description": "The blob SHA of the file being deleted."
31010
31364
  },
31011
31365
  "branch": {
31012
31366
  "type": "string",
@@ -36993,6 +37347,11 @@
36993
37347
  },
36994
37348
  "state_reason": {
36995
37349
  "type": "string",
37350
+ "enum": [
37351
+ "completed",
37352
+ "not_planned",
37353
+ "reopened"
37354
+ ],
36996
37355
  "nullable": true,
36997
37356
  "description": "The reason for the current state",
36998
37357
  "example": "not_planned"
@@ -56040,15 +56399,15 @@
56040
56399
  },
56041
56400
  "/user/packages/{package_type}/{package_name}/versions": {
56042
56401
  "get": {
56043
- "summary": "Get all package versions for a package owned by the authenticated user",
56044
- "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.",
56402
+ "summary": "List package versions for a package owned by the authenticated user",
56403
+ "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.",
56045
56404
  "tags": [
56046
56405
  "packages"
56047
56406
  ],
56048
56407
  "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
56049
56408
  "externalDocs": {
56050
56409
  "description": "API method documentation",
56051
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
56410
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
56052
56411
  },
56053
56412
  "parameters": [
56054
56413
  {
@@ -58536,15 +58895,15 @@
58536
58895
  },
58537
58896
  "/users/{username}/packages/{package_type}/{package_name}/versions": {
58538
58897
  "get": {
58539
- "summary": "Get all package versions for a package owned by a user",
58540
- "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.",
58898
+ "summary": "List package versions for a package owned by a user",
58899
+ "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.",
58541
58900
  "tags": [
58542
58901
  "packages"
58543
58902
  ],
58544
58903
  "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
58545
58904
  "externalDocs": {
58546
58905
  "description": "API method documentation",
58547
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58906
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58548
58907
  },
58549
58908
  "parameters": [
58550
58909
  {
@@ -61649,8 +62008,9 @@
61649
62008
  },
61650
62009
  "use_squash_pr_title_as_default": {
61651
62010
  "type": "boolean",
61652
- "description": "Whether a squash merge commit can use the pull request title as default.",
61653
- "default": false
62011
+ "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.",
62012
+ "default": false,
62013
+ "deprecated": true
61654
62014
  },
61655
62015
  "squash_merge_commit_title": {
61656
62016
  "type": "string",
@@ -64222,7 +64582,12 @@
64222
64582
  "description": "The reason for the current state",
64223
64583
  "example": "not_planned",
64224
64584
  "type": "string",
64225
- "nullable": true
64585
+ "nullable": true,
64586
+ "enum": [
64587
+ "completed",
64588
+ "reopened",
64589
+ "not_planned"
64590
+ ]
64226
64591
  },
64227
64592
  "title": {
64228
64593
  "description": "Title of the issue",
@@ -66602,8 +66967,9 @@
66602
66967
  },
66603
66968
  "use_squash_pr_title_as_default": {
66604
66969
  "type": "boolean",
66605
- "description": "Whether a squash merge commit can use the pull request title as default.",
66606
- "default": false
66970
+ "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.",
66971
+ "default": false,
66972
+ "deprecated": true
66607
66973
  },
66608
66974
  "squash_merge_commit_title": {
66609
66975
  "type": "string",
@@ -67307,6 +67673,39 @@
67307
67673
  "name": {
67308
67674
  "description": "The name of the custom role.",
67309
67675
  "type": "string"
67676
+ },
67677
+ "description": {
67678
+ "description": "A short description about who this role is for or what permissions it grants.",
67679
+ "type": "string",
67680
+ "nullable": true
67681
+ },
67682
+ "base_role": {
67683
+ "type": "string",
67684
+ "description": "The system role from which this role inherits permissions.",
67685
+ "enum": [
67686
+ "read",
67687
+ "triage",
67688
+ "write",
67689
+ "maintain"
67690
+ ]
67691
+ },
67692
+ "permissions": {
67693
+ "description": "A list of additional permissions included in this role.",
67694
+ "type": "array",
67695
+ "items": {
67696
+ "type": "string"
67697
+ }
67698
+ },
67699
+ "organization": {
67700
+ "$ref": "#/components/schemas/simple-user"
67701
+ },
67702
+ "created_at": {
67703
+ "type": "string",
67704
+ "format": "date-time"
67705
+ },
67706
+ "updated_at": {
67707
+ "type": "string",
67708
+ "format": "date-time"
67310
67709
  }
67311
67710
  },
67312
67711
  "required": [
@@ -68490,6 +68889,23 @@
68490
68889
  "node_id"
68491
68890
  ]
68492
68891
  },
68892
+ "organization-fine-grained-permission": {
68893
+ "title": "Organization Fine-Grained Permission",
68894
+ "description": "Fine-grained permissions available for the organization",
68895
+ "type": "object",
68896
+ "properties": {
68897
+ "name": {
68898
+ "type": "string"
68899
+ },
68900
+ "description": {
68901
+ "type": "string"
68902
+ }
68903
+ },
68904
+ "required": [
68905
+ "name",
68906
+ "description"
68907
+ ]
68908
+ },
68493
68909
  "org-hook": {
68494
68910
  "title": "Org Hook",
68495
68911
  "description": "Org Hook",
@@ -78851,7 +79267,12 @@
78851
79267
  "description": "The reason for the current state",
78852
79268
  "example": "not_planned",
78853
79269
  "type": "string",
78854
- "nullable": true
79270
+ "nullable": true,
79271
+ "enum": [
79272
+ "completed",
79273
+ "reopened",
79274
+ "not_planned"
79275
+ ]
78855
79276
  },
78856
79277
  "title": {
78857
79278
  "description": "Title of the issue",
@@ -91942,17 +92363,76 @@
91942
92363
  }
91943
92364
  ]
91944
92365
  },
91945
- "organization-custom-repository-role-example-old": {
92366
+ "organization-custom-repository-role-example": {
91946
92367
  "value": {
91947
92368
  "total_count": 2,
91948
92369
  "custom_roles": [
91949
92370
  {
91950
92371
  "id": 8030,
91951
- "name": "Developer"
92372
+ "name": "Security Engineer",
92373
+ "description": "Able to contribute code and maintain the security pipeline",
92374
+ "base_role": "maintain",
92375
+ "permissions": [
92376
+ "delete_alerts_code_scanning"
92377
+ ],
92378
+ "organization": {
92379
+ "login": "github",
92380
+ "id": 9919,
92381
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92382
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92383
+ "gravatar_id": "",
92384
+ "url": "https://api.github.com/users/github",
92385
+ "html_url": "https://github.com/github",
92386
+ "followers_url": "https://api.github.com/users/github/followers",
92387
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92388
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92389
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92390
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92391
+ "organizations_url": "https://api.github.com/users/github/orgs",
92392
+ "repos_url": "https://api.github.com/users/github/repos",
92393
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92394
+ "received_events_url": "https://api.github.com/users/github/received_events",
92395
+ "type": "Organization",
92396
+ "site_admin": false
92397
+ },
92398
+ "created_at": "2022-07-04T22:19:11Z",
92399
+ "updated_at": "2022-07-04T22:20:11Z"
91952
92400
  },
91953
92401
  {
91954
92402
  "id": 8031,
91955
- "name": "Designer"
92403
+ "name": "Community manager",
92404
+ "description": "Able to handle all the community interactions without being able to contribute code",
92405
+ "base_role": "read",
92406
+ "permissions": [
92407
+ "mark_as_duplicate",
92408
+ "manage_settings_pages",
92409
+ "manage_settings_wiki",
92410
+ "set_social_preview",
92411
+ "edit_repo_metadata",
92412
+ "toggle_discussion_comment_minimize"
92413
+ ],
92414
+ "organization": {
92415
+ "login": "github",
92416
+ "id": 9919,
92417
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92418
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92419
+ "gravatar_id": "",
92420
+ "url": "https://api.github.com/users/github",
92421
+ "html_url": "https://github.com/github",
92422
+ "followers_url": "https://api.github.com/users/github/followers",
92423
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92424
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92425
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92426
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92427
+ "organizations_url": "https://api.github.com/users/github/orgs",
92428
+ "repos_url": "https://api.github.com/users/github/repos",
92429
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92430
+ "received_events_url": "https://api.github.com/users/github/received_events",
92431
+ "type": "Organization",
92432
+ "site_admin": false
92433
+ },
92434
+ "created_at": "2022-07-05T12:01:11Z",
92435
+ "updated_at": "2022-07-05T12:20:11Z"
91956
92436
  }
91957
92437
  ]
91958
92438
  }
@@ -93354,6 +93834,22 @@
93354
93834
  }
93355
93835
  ]
93356
93836
  },
93837
+ "organization-fine-grained-permission-example": {
93838
+ "value": [
93839
+ {
93840
+ "name": "add_assignee",
93841
+ "description": "Assign or remove a user"
93842
+ },
93843
+ {
93844
+ "name": "remove_assignee",
93845
+ "description": "Remove an assigned user"
93846
+ },
93847
+ {
93848
+ "name": "add_label",
93849
+ "description": "Add or remove a label"
93850
+ }
93851
+ ]
93852
+ },
93357
93853
  "org-hook-items": {
93358
93854
  "value": [
93359
93855
  {
@@ -93723,14 +94219,15 @@
93723
94219
  },
93724
94220
  "location": "WestUs2",
93725
94221
  "idle_timeout_minutes": 60,
93726
- "retention_period_minutes": "43200,",
93727
- "retention_expires_at": "null,",
94222
+ "retention_period_minutes": 43200,
94223
+ "retention_expires_at": null,
93728
94224
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
93729
94225
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
93730
94226
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
93731
94227
  "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
93732
94228
  "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
93733
- "recent_folders": []
94229
+ "recent_folders": [],
94230
+ "template": null
93734
94231
  }
93735
94232
  },
93736
94233
  "org-membership-response-if-user-has-an-active-admin-membership-with-organization": {
@@ -112926,6 +113423,15 @@
112926
113423
  "type": "string"
112927
113424
  }
112928
113425
  },
113426
+ "role-id": {
113427
+ "name": "role_id",
113428
+ "description": "The unique identifier of the role.",
113429
+ "in": "path",
113430
+ "required": true,
113431
+ "schema": {
113432
+ "type": "integer"
113433
+ }
113434
+ },
112929
113435
  "group-id": {
112930
113436
  "name": "group_id",
112931
113437
  "description": "The unique identifier of the group.",
@@ -113288,6 +113794,15 @@
113288
113794
  "type": "integer"
113289
113795
  }
113290
113796
  },
113797
+ "workflow-run-head-sha": {
113798
+ "name": "head_sha",
113799
+ "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
113800
+ "in": "query",
113801
+ "required": false,
113802
+ "schema": {
113803
+ "type": "string"
113804
+ }
113805
+ },
113291
113806
  "run-id": {
113292
113807
  "name": "run_id",
113293
113808
  "description": "The unique identifier of the workflow run.",