@octokit/openapi 7.9.0 → 7.11.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 +2604 -719
  2. package/generated/api.github.com.json +539 -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 +8 -6
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +8 -6
  7. package/generated/ghes-3.2.deref.json +745 -128
  8. package/generated/ghes-3.2.json +35 -8
  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 +910 -293
  13. package/generated/ghes-3.3.json +35 -8
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +2 -2
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +2 -2
  16. package/generated/ghes-3.4.deref.json +750 -128
  17. package/generated/ghes-3.4.json +37 -10
  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 +915 -293
  24. package/generated/ghes-3.5.json +37 -10
  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 +125 -20
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +110 -6
  28. package/generated/ghes-3.6.deref.json +1236 -419
  29. package/generated/ghes-3.6.json +142 -21
  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 +8 -6
  32. package/generated/github.ae-diff-to-api.github.com.json +8 -6
  33. package/generated/github.ae.deref.json +1001 -288
  34. package/generated/github.ae.json +127 -14
  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.0",
4
+ "version": "7.11.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",
@@ -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"
@@ -30652,6 +31024,7 @@
30652
31024
  "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
30653
31025
  "in": "path",
30654
31026
  "required": true,
31027
+ "x-multi-segment": true,
30655
31028
  "schema": {
30656
31029
  "type": "string"
30657
31030
  }
@@ -31012,7 +31385,7 @@
31012
31385
  },
31013
31386
  "sha": {
31014
31387
  "type": "string",
31015
- "description": "The blob SHA of the file being replaced."
31388
+ "description": "The blob SHA of the file being deleted."
31016
31389
  },
31017
31390
  "branch": {
31018
31391
  "type": "string",
@@ -34147,7 +34520,7 @@
34147
34520
  "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
34148
34521
  "get": {
34149
34522
  "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.",
34523
+ "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
34524
  "tags": [
34152
34525
  "git"
34153
34526
  ],
@@ -56051,15 +56424,15 @@
56051
56424
  },
56052
56425
  "/user/packages/{package_type}/{package_name}/versions": {
56053
56426
  "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.",
56427
+ "summary": "List package versions for a package owned by the authenticated user",
56428
+ "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
56429
  "tags": [
56057
56430
  "packages"
56058
56431
  ],
56059
56432
  "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
56060
56433
  "externalDocs": {
56061
56434
  "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"
56435
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
56063
56436
  },
56064
56437
  "parameters": [
56065
56438
  {
@@ -57047,7 +57420,7 @@
57047
57420
  "key": {
57048
57421
  "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
57422
  "type": "string",
57050
- "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
57423
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
57051
57424
  }
57052
57425
  },
57053
57426
  "required": [
@@ -58547,15 +58920,15 @@
58547
58920
  },
58548
58921
  "/users/{username}/packages/{package_type}/{package_name}/versions": {
58549
58922
  "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.",
58923
+ "summary": "List package versions for a package owned by a user",
58924
+ "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
58925
  "tags": [
58553
58926
  "packages"
58554
58927
  ],
58555
58928
  "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
58556
58929
  "externalDocs": {
58557
58930
  "description": "API method documentation",
58558
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58931
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
58559
58932
  },
58560
58933
  "parameters": [
58561
58934
  {
@@ -61660,8 +62033,9 @@
61660
62033
  },
61661
62034
  "use_squash_pr_title_as_default": {
61662
62035
  "type": "boolean",
61663
- "description": "Whether a squash merge commit can use the pull request title as default.",
61664
- "default": false
62036
+ "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.",
62037
+ "default": false,
62038
+ "deprecated": true
61665
62039
  },
61666
62040
  "squash_merge_commit_title": {
61667
62041
  "type": "string",
@@ -66618,8 +66992,9 @@
66618
66992
  },
66619
66993
  "use_squash_pr_title_as_default": {
66620
66994
  "type": "boolean",
66621
- "description": "Whether a squash merge commit can use the pull request title as default.",
66622
- "default": false
66995
+ "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.",
66996
+ "default": false,
66997
+ "deprecated": true
66623
66998
  },
66624
66999
  "squash_merge_commit_title": {
66625
67000
  "type": "string",
@@ -67323,6 +67698,39 @@
67323
67698
  "name": {
67324
67699
  "description": "The name of the custom role.",
67325
67700
  "type": "string"
67701
+ },
67702
+ "description": {
67703
+ "description": "A short description about who this role is for or what permissions it grants.",
67704
+ "type": "string",
67705
+ "nullable": true
67706
+ },
67707
+ "base_role": {
67708
+ "type": "string",
67709
+ "description": "The system role from which this role inherits permissions.",
67710
+ "enum": [
67711
+ "read",
67712
+ "triage",
67713
+ "write",
67714
+ "maintain"
67715
+ ]
67716
+ },
67717
+ "permissions": {
67718
+ "description": "A list of additional permissions included in this role.",
67719
+ "type": "array",
67720
+ "items": {
67721
+ "type": "string"
67722
+ }
67723
+ },
67724
+ "organization": {
67725
+ "$ref": "#/components/schemas/simple-user"
67726
+ },
67727
+ "created_at": {
67728
+ "type": "string",
67729
+ "format": "date-time"
67730
+ },
67731
+ "updated_at": {
67732
+ "type": "string",
67733
+ "format": "date-time"
67326
67734
  }
67327
67735
  },
67328
67736
  "required": [
@@ -68506,6 +68914,23 @@
68506
68914
  "node_id"
68507
68915
  ]
68508
68916
  },
68917
+ "organization-fine-grained-permission": {
68918
+ "title": "Organization Fine-Grained Permission",
68919
+ "description": "Fine-grained permissions available for the organization",
68920
+ "type": "object",
68921
+ "properties": {
68922
+ "name": {
68923
+ "type": "string"
68924
+ },
68925
+ "description": {
68926
+ "type": "string"
68927
+ }
68928
+ },
68929
+ "required": [
68930
+ "name",
68931
+ "description"
68932
+ ]
68933
+ },
68509
68934
  "org-hook": {
68510
68935
  "title": "Org Hook",
68511
68936
  "description": "Org Hook",
@@ -91963,17 +92388,76 @@
91963
92388
  }
91964
92389
  ]
91965
92390
  },
91966
- "organization-custom-repository-role-example-old": {
92391
+ "organization-custom-repository-role-example": {
91967
92392
  "value": {
91968
92393
  "total_count": 2,
91969
92394
  "custom_roles": [
91970
92395
  {
91971
92396
  "id": 8030,
91972
- "name": "Developer"
92397
+ "name": "Security Engineer",
92398
+ "description": "Able to contribute code and maintain the security pipeline",
92399
+ "base_role": "maintain",
92400
+ "permissions": [
92401
+ "delete_alerts_code_scanning"
92402
+ ],
92403
+ "organization": {
92404
+ "login": "github",
92405
+ "id": 9919,
92406
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92407
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92408
+ "gravatar_id": "",
92409
+ "url": "https://api.github.com/users/github",
92410
+ "html_url": "https://github.com/github",
92411
+ "followers_url": "https://api.github.com/users/github/followers",
92412
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92413
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92414
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92415
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92416
+ "organizations_url": "https://api.github.com/users/github/orgs",
92417
+ "repos_url": "https://api.github.com/users/github/repos",
92418
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92419
+ "received_events_url": "https://api.github.com/users/github/received_events",
92420
+ "type": "Organization",
92421
+ "site_admin": false
92422
+ },
92423
+ "created_at": "2022-07-04T22:19:11Z",
92424
+ "updated_at": "2022-07-04T22:20:11Z"
91973
92425
  },
91974
92426
  {
91975
92427
  "id": 8031,
91976
- "name": "Designer"
92428
+ "name": "Community manager",
92429
+ "description": "Able to handle all the community interactions without being able to contribute code",
92430
+ "base_role": "read",
92431
+ "permissions": [
92432
+ "mark_as_duplicate",
92433
+ "manage_settings_pages",
92434
+ "manage_settings_wiki",
92435
+ "set_social_preview",
92436
+ "edit_repo_metadata",
92437
+ "toggle_discussion_comment_minimize"
92438
+ ],
92439
+ "organization": {
92440
+ "login": "github",
92441
+ "id": 9919,
92442
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
92443
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
92444
+ "gravatar_id": "",
92445
+ "url": "https://api.github.com/users/github",
92446
+ "html_url": "https://github.com/github",
92447
+ "followers_url": "https://api.github.com/users/github/followers",
92448
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
92449
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
92450
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
92451
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
92452
+ "organizations_url": "https://api.github.com/users/github/orgs",
92453
+ "repos_url": "https://api.github.com/users/github/repos",
92454
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
92455
+ "received_events_url": "https://api.github.com/users/github/received_events",
92456
+ "type": "Organization",
92457
+ "site_admin": false
92458
+ },
92459
+ "created_at": "2022-07-05T12:01:11Z",
92460
+ "updated_at": "2022-07-05T12:20:11Z"
91977
92461
  }
91978
92462
  ]
91979
92463
  }
@@ -93375,6 +93859,22 @@
93375
93859
  }
93376
93860
  ]
93377
93861
  },
93862
+ "organization-fine-grained-permission-example": {
93863
+ "value": [
93864
+ {
93865
+ "name": "add_assignee",
93866
+ "description": "Assign or remove a user"
93867
+ },
93868
+ {
93869
+ "name": "remove_assignee",
93870
+ "description": "Remove an assigned user"
93871
+ },
93872
+ {
93873
+ "name": "add_label",
93874
+ "description": "Add or remove a label"
93875
+ }
93876
+ ]
93877
+ },
93378
93878
  "org-hook-items": {
93379
93879
  "value": [
93380
93880
  {
@@ -93744,14 +94244,15 @@
93744
94244
  },
93745
94245
  "location": "WestUs2",
93746
94246
  "idle_timeout_minutes": 60,
93747
- "retention_period_minutes": "43200,",
93748
- "retention_expires_at": "null,",
94247
+ "retention_period_minutes": 43200,
94248
+ "retention_expires_at": null,
93749
94249
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
93750
94250
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
93751
94251
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
93752
94252
  "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
93753
94253
  "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
93754
- "recent_folders": []
94254
+ "recent_folders": [],
94255
+ "template": null
93755
94256
  }
93756
94257
  },
93757
94258
  "org-membership-response-if-user-has-an-active-admin-membership-with-organization": {
@@ -112947,6 +113448,15 @@
112947
113448
  "type": "string"
112948
113449
  }
112949
113450
  },
113451
+ "role-id": {
113452
+ "name": "role_id",
113453
+ "description": "The unique identifier of the role.",
113454
+ "in": "path",
113455
+ "required": true,
113456
+ "schema": {
113457
+ "type": "integer"
113458
+ }
113459
+ },
112950
113460
  "group-id": {
112951
113461
  "name": "group_id",
112952
113462
  "description": "The unique identifier of the group.",