@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": {
@@ -97394,8 +97394,9 @@
97394
97394
  },
97395
97395
  "use_squash_pr_title_as_default": {
97396
97396
  "type": "boolean",
97397
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
97398
- "default": false
97397
+ "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.",
97398
+ "default": false,
97399
+ "deprecated": true
97399
97400
  },
97400
97401
  "squash_merge_commit_title": {
97401
97402
  "type": "string",
@@ -100223,18 +100224,723 @@
100223
100224
  "category": "teams",
100224
100225
  "subcategory": null
100225
100226
  },
100226
- "x-octokit": {}
100227
- },
100228
- "post": {
100229
- "summary": "Create a team",
100230
- "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
100227
+ "x-octokit": {}
100228
+ },
100229
+ "post": {
100230
+ "summary": "Create a team",
100231
+ "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
100232
+ "tags": [
100233
+ "teams"
100234
+ ],
100235
+ "operationId": "teams/create",
100236
+ "externalDocs": {
100237
+ "description": "API method documentation",
100238
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-team"
100239
+ },
100240
+ "parameters": [
100241
+ {
100242
+ "name": "org",
100243
+ "description": "The organization name. The name is not case sensitive.",
100244
+ "in": "path",
100245
+ "required": true,
100246
+ "schema": {
100247
+ "type": "string"
100248
+ }
100249
+ }
100250
+ ],
100251
+ "requestBody": {
100252
+ "required": true,
100253
+ "content": {
100254
+ "application/json": {
100255
+ "schema": {
100256
+ "type": "object",
100257
+ "properties": {
100258
+ "name": {
100259
+ "type": "string",
100260
+ "description": "The name of the team."
100261
+ },
100262
+ "description": {
100263
+ "type": "string",
100264
+ "description": "The description of the team."
100265
+ },
100266
+ "maintainers": {
100267
+ "type": "array",
100268
+ "description": "List GitHub IDs for organization members who will become team maintainers.",
100269
+ "items": {
100270
+ "type": "string"
100271
+ }
100272
+ },
100273
+ "repo_names": {
100274
+ "type": "array",
100275
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
100276
+ "items": {
100277
+ "type": "string"
100278
+ }
100279
+ },
100280
+ "privacy": {
100281
+ "type": "string",
100282
+ "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`",
100283
+ "enum": [
100284
+ "secret",
100285
+ "closed"
100286
+ ]
100287
+ },
100288
+ "permission": {
100289
+ "type": "string",
100290
+ "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
100291
+ "enum": [
100292
+ "pull",
100293
+ "push"
100294
+ ],
100295
+ "default": "pull"
100296
+ },
100297
+ "parent_team_id": {
100298
+ "type": "integer",
100299
+ "description": "The ID of a team to set as the parent team."
100300
+ },
100301
+ "ldap_dn": {
100302
+ "type": "string",
100303
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\""
100304
+ }
100305
+ },
100306
+ "required": [
100307
+ "name"
100308
+ ]
100309
+ },
100310
+ "examples": {
100311
+ "default": {
100312
+ "value": {
100313
+ "name": "Justice League",
100314
+ "description": "A great team",
100315
+ "permission": "push",
100316
+ "privacy": "closed"
100317
+ }
100318
+ }
100319
+ }
100320
+ }
100321
+ }
100322
+ },
100323
+ "responses": {
100324
+ "201": {
100325
+ "description": "Response",
100326
+ "content": {
100327
+ "application/json": {
100328
+ "schema": {
100329
+ "title": "Full Team",
100330
+ "description": "Groups of organization members that gives permissions on specified repositories.",
100331
+ "type": "object",
100332
+ "properties": {
100333
+ "id": {
100334
+ "description": "Unique identifier of the team",
100335
+ "example": 42,
100336
+ "type": "integer"
100337
+ },
100338
+ "node_id": {
100339
+ "type": "string",
100340
+ "example": "MDQ6VGVhbTE="
100341
+ },
100342
+ "url": {
100343
+ "description": "URL for the team",
100344
+ "example": "https://api.github.com/organizations/1/team/1",
100345
+ "type": "string",
100346
+ "format": "uri"
100347
+ },
100348
+ "html_url": {
100349
+ "type": "string",
100350
+ "format": "uri",
100351
+ "example": "https://github.com/orgs/rails/teams/core"
100352
+ },
100353
+ "name": {
100354
+ "description": "Name of the team",
100355
+ "example": "Developers",
100356
+ "type": "string"
100357
+ },
100358
+ "slug": {
100359
+ "type": "string",
100360
+ "example": "justice-league"
100361
+ },
100362
+ "description": {
100363
+ "type": "string",
100364
+ "example": "A great team.",
100365
+ "nullable": true
100366
+ },
100367
+ "privacy": {
100368
+ "description": "The level of privacy this team should have",
100369
+ "type": "string",
100370
+ "enum": [
100371
+ "closed",
100372
+ "secret"
100373
+ ],
100374
+ "example": "closed"
100375
+ },
100376
+ "permission": {
100377
+ "description": "Permission that the team will have for its repositories",
100378
+ "example": "push",
100379
+ "type": "string"
100380
+ },
100381
+ "members_url": {
100382
+ "type": "string",
100383
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
100384
+ },
100385
+ "repositories_url": {
100386
+ "type": "string",
100387
+ "format": "uri",
100388
+ "example": "https://api.github.com/organizations/1/team/1/repos"
100389
+ },
100390
+ "parent": {
100391
+ "title": "Team Simple",
100392
+ "description": "Groups of organization members that gives permissions on specified repositories.",
100393
+ "type": "object",
100394
+ "properties": {
100395
+ "id": {
100396
+ "description": "Unique identifier of the team",
100397
+ "type": "integer",
100398
+ "example": 1
100399
+ },
100400
+ "node_id": {
100401
+ "type": "string",
100402
+ "example": "MDQ6VGVhbTE="
100403
+ },
100404
+ "url": {
100405
+ "description": "URL for the team",
100406
+ "type": "string",
100407
+ "format": "uri",
100408
+ "example": "https://api.github.com/organizations/1/team/1"
100409
+ },
100410
+ "members_url": {
100411
+ "type": "string",
100412
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
100413
+ },
100414
+ "name": {
100415
+ "description": "Name of the team",
100416
+ "type": "string",
100417
+ "example": "Justice League"
100418
+ },
100419
+ "description": {
100420
+ "description": "Description of the team",
100421
+ "type": "string",
100422
+ "nullable": true,
100423
+ "example": "A great team."
100424
+ },
100425
+ "permission": {
100426
+ "description": "Permission that the team will have for its repositories",
100427
+ "type": "string",
100428
+ "example": "admin"
100429
+ },
100430
+ "privacy": {
100431
+ "description": "The level of privacy this team should have",
100432
+ "type": "string",
100433
+ "example": "closed"
100434
+ },
100435
+ "html_url": {
100436
+ "type": "string",
100437
+ "format": "uri",
100438
+ "example": "https://github.com/orgs/rails/teams/core"
100439
+ },
100440
+ "repositories_url": {
100441
+ "type": "string",
100442
+ "format": "uri",
100443
+ "example": "https://api.github.com/organizations/1/team/1/repos"
100444
+ },
100445
+ "slug": {
100446
+ "type": "string",
100447
+ "example": "justice-league"
100448
+ },
100449
+ "ldap_dn": {
100450
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
100451
+ "example": "uid=example,ou=users,dc=github,dc=com",
100452
+ "type": "string"
100453
+ }
100454
+ },
100455
+ "required": [
100456
+ "id",
100457
+ "node_id",
100458
+ "url",
100459
+ "members_url",
100460
+ "name",
100461
+ "description",
100462
+ "permission",
100463
+ "html_url",
100464
+ "repositories_url",
100465
+ "slug"
100466
+ ],
100467
+ "nullable": true
100468
+ },
100469
+ "members_count": {
100470
+ "type": "integer",
100471
+ "example": 3
100472
+ },
100473
+ "repos_count": {
100474
+ "type": "integer",
100475
+ "example": 10
100476
+ },
100477
+ "created_at": {
100478
+ "type": "string",
100479
+ "format": "date-time",
100480
+ "example": "2017-07-14T16:53:42Z"
100481
+ },
100482
+ "updated_at": {
100483
+ "type": "string",
100484
+ "format": "date-time",
100485
+ "example": "2017-08-17T12:37:15Z"
100486
+ },
100487
+ "organization": {
100488
+ "title": "Team Organization",
100489
+ "description": "Team Organization",
100490
+ "type": "object",
100491
+ "properties": {
100492
+ "login": {
100493
+ "type": "string",
100494
+ "example": "github"
100495
+ },
100496
+ "id": {
100497
+ "type": "integer",
100498
+ "example": 1
100499
+ },
100500
+ "node_id": {
100501
+ "type": "string",
100502
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
100503
+ },
100504
+ "url": {
100505
+ "type": "string",
100506
+ "format": "uri",
100507
+ "example": "https://api.github.com/orgs/github"
100508
+ },
100509
+ "repos_url": {
100510
+ "type": "string",
100511
+ "format": "uri",
100512
+ "example": "https://api.github.com/orgs/github/repos"
100513
+ },
100514
+ "events_url": {
100515
+ "type": "string",
100516
+ "format": "uri",
100517
+ "example": "https://api.github.com/orgs/github/events"
100518
+ },
100519
+ "hooks_url": {
100520
+ "type": "string",
100521
+ "example": "https://api.github.com/orgs/github/hooks"
100522
+ },
100523
+ "issues_url": {
100524
+ "type": "string",
100525
+ "example": "https://api.github.com/orgs/github/issues"
100526
+ },
100527
+ "members_url": {
100528
+ "type": "string",
100529
+ "example": "https://api.github.com/orgs/github/members{/member}"
100530
+ },
100531
+ "public_members_url": {
100532
+ "type": "string",
100533
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
100534
+ },
100535
+ "avatar_url": {
100536
+ "type": "string",
100537
+ "example": "https://github.com/images/error/octocat_happy.gif"
100538
+ },
100539
+ "description": {
100540
+ "type": "string",
100541
+ "example": "A great organization",
100542
+ "nullable": true
100543
+ },
100544
+ "name": {
100545
+ "type": "string",
100546
+ "example": "github"
100547
+ },
100548
+ "company": {
100549
+ "type": "string",
100550
+ "example": "GitHub"
100551
+ },
100552
+ "blog": {
100553
+ "type": "string",
100554
+ "format": "uri",
100555
+ "example": "https://github.com/blog"
100556
+ },
100557
+ "location": {
100558
+ "type": "string",
100559
+ "example": "San Francisco"
100560
+ },
100561
+ "email": {
100562
+ "type": "string",
100563
+ "format": "email",
100564
+ "example": "octocat@github.com"
100565
+ },
100566
+ "twitter_username": {
100567
+ "type": "string",
100568
+ "example": "github",
100569
+ "nullable": true
100570
+ },
100571
+ "is_verified": {
100572
+ "type": "boolean",
100573
+ "example": true
100574
+ },
100575
+ "has_organization_projects": {
100576
+ "type": "boolean",
100577
+ "example": true
100578
+ },
100579
+ "has_repository_projects": {
100580
+ "type": "boolean",
100581
+ "example": true
100582
+ },
100583
+ "public_repos": {
100584
+ "type": "integer",
100585
+ "example": 2
100586
+ },
100587
+ "public_gists": {
100588
+ "type": "integer",
100589
+ "example": 1
100590
+ },
100591
+ "followers": {
100592
+ "type": "integer",
100593
+ "example": 20
100594
+ },
100595
+ "following": {
100596
+ "type": "integer",
100597
+ "example": 0
100598
+ },
100599
+ "html_url": {
100600
+ "type": "string",
100601
+ "format": "uri",
100602
+ "example": "https://github.com/octocat"
100603
+ },
100604
+ "created_at": {
100605
+ "type": "string",
100606
+ "format": "date-time",
100607
+ "example": "2008-01-14T04:33:35Z"
100608
+ },
100609
+ "type": {
100610
+ "type": "string",
100611
+ "example": "Organization"
100612
+ },
100613
+ "total_private_repos": {
100614
+ "type": "integer",
100615
+ "example": 100
100616
+ },
100617
+ "owned_private_repos": {
100618
+ "type": "integer",
100619
+ "example": 100
100620
+ },
100621
+ "private_gists": {
100622
+ "type": "integer",
100623
+ "example": 81,
100624
+ "nullable": true
100625
+ },
100626
+ "disk_usage": {
100627
+ "type": "integer",
100628
+ "example": 10000,
100629
+ "nullable": true
100630
+ },
100631
+ "collaborators": {
100632
+ "type": "integer",
100633
+ "example": 8,
100634
+ "nullable": true
100635
+ },
100636
+ "billing_email": {
100637
+ "type": "string",
100638
+ "format": "email",
100639
+ "example": "org@example.com",
100640
+ "nullable": true
100641
+ },
100642
+ "plan": {
100643
+ "type": "object",
100644
+ "properties": {
100645
+ "name": {
100646
+ "type": "string"
100647
+ },
100648
+ "space": {
100649
+ "type": "integer"
100650
+ },
100651
+ "private_repos": {
100652
+ "type": "integer"
100653
+ },
100654
+ "filled_seats": {
100655
+ "type": "integer"
100656
+ },
100657
+ "seats": {
100658
+ "type": "integer"
100659
+ }
100660
+ },
100661
+ "required": [
100662
+ "name",
100663
+ "space",
100664
+ "private_repos"
100665
+ ]
100666
+ },
100667
+ "default_repository_permission": {
100668
+ "type": "string",
100669
+ "nullable": true
100670
+ },
100671
+ "members_can_create_repositories": {
100672
+ "type": "boolean",
100673
+ "example": true,
100674
+ "nullable": true
100675
+ },
100676
+ "two_factor_requirement_enabled": {
100677
+ "type": "boolean",
100678
+ "example": true,
100679
+ "nullable": true
100680
+ },
100681
+ "members_allowed_repository_creation_type": {
100682
+ "type": "string",
100683
+ "example": "all"
100684
+ },
100685
+ "members_can_create_public_repositories": {
100686
+ "type": "boolean",
100687
+ "example": true
100688
+ },
100689
+ "members_can_create_private_repositories": {
100690
+ "type": "boolean",
100691
+ "example": true
100692
+ },
100693
+ "members_can_create_internal_repositories": {
100694
+ "type": "boolean",
100695
+ "example": true
100696
+ },
100697
+ "members_can_create_pages": {
100698
+ "type": "boolean",
100699
+ "example": true
100700
+ },
100701
+ "members_can_create_public_pages": {
100702
+ "type": "boolean",
100703
+ "example": true
100704
+ },
100705
+ "members_can_create_private_pages": {
100706
+ "type": "boolean",
100707
+ "example": true
100708
+ },
100709
+ "members_can_fork_private_repositories": {
100710
+ "type": "boolean",
100711
+ "example": false,
100712
+ "nullable": true
100713
+ },
100714
+ "updated_at": {
100715
+ "type": "string",
100716
+ "format": "date-time"
100717
+ }
100718
+ },
100719
+ "required": [
100720
+ "login",
100721
+ "url",
100722
+ "id",
100723
+ "node_id",
100724
+ "repos_url",
100725
+ "events_url",
100726
+ "hooks_url",
100727
+ "issues_url",
100728
+ "members_url",
100729
+ "public_members_url",
100730
+ "avatar_url",
100731
+ "description",
100732
+ "html_url",
100733
+ "has_organization_projects",
100734
+ "has_repository_projects",
100735
+ "public_repos",
100736
+ "public_gists",
100737
+ "followers",
100738
+ "following",
100739
+ "type",
100740
+ "created_at",
100741
+ "updated_at"
100742
+ ]
100743
+ },
100744
+ "ldap_dn": {
100745
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
100746
+ "example": "uid=example,ou=users,dc=github,dc=com",
100747
+ "type": "string"
100748
+ }
100749
+ },
100750
+ "required": [
100751
+ "id",
100752
+ "node_id",
100753
+ "url",
100754
+ "members_url",
100755
+ "name",
100756
+ "description",
100757
+ "permission",
100758
+ "html_url",
100759
+ "repositories_url",
100760
+ "slug",
100761
+ "created_at",
100762
+ "updated_at",
100763
+ "members_count",
100764
+ "repos_count",
100765
+ "organization"
100766
+ ]
100767
+ },
100768
+ "examples": {
100769
+ "default": {
100770
+ "value": {
100771
+ "id": 1,
100772
+ "node_id": "MDQ6VGVhbTE=",
100773
+ "url": "https://api.github.com/teams/1",
100774
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
100775
+ "name": "Justice League",
100776
+ "slug": "justice-league",
100777
+ "description": "A great team.",
100778
+ "privacy": "closed",
100779
+ "permission": "admin",
100780
+ "members_url": "https://api.github.com/teams/1/members{/member}",
100781
+ "repositories_url": "https://api.github.com/teams/1/repos",
100782
+ "members_count": 3,
100783
+ "repos_count": 10,
100784
+ "created_at": "2017-07-14T16:53:42Z",
100785
+ "updated_at": "2017-08-17T12:37:15Z",
100786
+ "organization": {
100787
+ "login": "github",
100788
+ "id": 1,
100789
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
100790
+ "url": "https://api.github.com/orgs/github",
100791
+ "repos_url": "https://api.github.com/orgs/github/repos",
100792
+ "events_url": "https://api.github.com/orgs/github/events",
100793
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
100794
+ "issues_url": "https://api.github.com/orgs/github/issues",
100795
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
100796
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
100797
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
100798
+ "description": "A great organization",
100799
+ "name": "github",
100800
+ "company": "GitHub",
100801
+ "blog": "https://github.com/blog",
100802
+ "location": "San Francisco",
100803
+ "email": "octocat@github.com",
100804
+ "has_organization_projects": true,
100805
+ "has_repository_projects": true,
100806
+ "public_repos": 2,
100807
+ "public_gists": 1,
100808
+ "followers": 20,
100809
+ "following": 0,
100810
+ "html_url": "https://github.com/octocat",
100811
+ "created_at": "2008-01-14T04:33:35Z",
100812
+ "updated_at": "2017-08-17T12:37:15Z",
100813
+ "type": "Organization"
100814
+ },
100815
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
100816
+ }
100817
+ }
100818
+ }
100819
+ }
100820
+ }
100821
+ },
100822
+ "403": {
100823
+ "description": "Forbidden",
100824
+ "content": {
100825
+ "application/json": {
100826
+ "schema": {
100827
+ "title": "Basic Error",
100828
+ "description": "Basic Error",
100829
+ "type": "object",
100830
+ "properties": {
100831
+ "message": {
100832
+ "type": "string"
100833
+ },
100834
+ "documentation_url": {
100835
+ "type": "string"
100836
+ },
100837
+ "url": {
100838
+ "type": "string"
100839
+ },
100840
+ "status": {
100841
+ "type": "string"
100842
+ }
100843
+ }
100844
+ }
100845
+ }
100846
+ }
100847
+ },
100848
+ "422": {
100849
+ "description": "Validation failed",
100850
+ "content": {
100851
+ "application/json": {
100852
+ "schema": {
100853
+ "title": "Validation Error",
100854
+ "description": "Validation Error",
100855
+ "type": "object",
100856
+ "required": [
100857
+ "message",
100858
+ "documentation_url"
100859
+ ],
100860
+ "properties": {
100861
+ "message": {
100862
+ "type": "string"
100863
+ },
100864
+ "documentation_url": {
100865
+ "type": "string"
100866
+ },
100867
+ "errors": {
100868
+ "type": "array",
100869
+ "items": {
100870
+ "type": "object",
100871
+ "required": [
100872
+ "code"
100873
+ ],
100874
+ "properties": {
100875
+ "resource": {
100876
+ "type": "string"
100877
+ },
100878
+ "field": {
100879
+ "type": "string"
100880
+ },
100881
+ "message": {
100882
+ "type": "string"
100883
+ },
100884
+ "code": {
100885
+ "type": "string"
100886
+ },
100887
+ "index": {
100888
+ "type": "integer"
100889
+ },
100890
+ "value": {
100891
+ "oneOf": [
100892
+ {
100893
+ "type": "string",
100894
+ "nullable": true
100895
+ },
100896
+ {
100897
+ "type": "integer",
100898
+ "nullable": true
100899
+ },
100900
+ {
100901
+ "type": "array",
100902
+ "nullable": true,
100903
+ "items": {
100904
+ "type": "string"
100905
+ }
100906
+ }
100907
+ ]
100908
+ }
100909
+ }
100910
+ }
100911
+ }
100912
+ }
100913
+ }
100914
+ }
100915
+ }
100916
+ }
100917
+ },
100918
+ "x-github": {
100919
+ "githubCloudOnly": false,
100920
+ "enabledForGitHubApps": true,
100921
+ "category": "teams",
100922
+ "subcategory": null
100923
+ },
100924
+ "x-octokit": {
100925
+ "diff": {
100926
+ "ghes-3.6": {
100927
+ "type": "changed"
100928
+ }
100929
+ }
100930
+ }
100931
+ }
100932
+ },
100933
+ "/orgs/{org}/teams/{team_slug}": {
100934
+ "get": {
100935
+ "summary": "Get a team by name",
100936
+ "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.",
100231
100937
  "tags": [
100232
100938
  "teams"
100233
100939
  ],
100234
- "operationId": "teams/create",
100940
+ "operationId": "teams/get-by-name",
100235
100941
  "externalDocs": {
100236
100942
  "description": "API method documentation",
100237
- "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-team"
100943
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#get-a-team-by-name"
100238
100944
  },
100239
100945
  "parameters": [
100240
100946
  {
@@ -100245,82 +100951,19 @@
100245
100951
  "schema": {
100246
100952
  "type": "string"
100247
100953
  }
100248
- }
100249
- ],
100250
- "requestBody": {
100251
- "required": true,
100252
- "content": {
100253
- "application/json": {
100254
- "schema": {
100255
- "type": "object",
100256
- "properties": {
100257
- "name": {
100258
- "type": "string",
100259
- "description": "The name of the team."
100260
- },
100261
- "description": {
100262
- "type": "string",
100263
- "description": "The description of the team."
100264
- },
100265
- "maintainers": {
100266
- "type": "array",
100267
- "description": "List GitHub IDs for organization members who will become team maintainers.",
100268
- "items": {
100269
- "type": "string"
100270
- }
100271
- },
100272
- "repo_names": {
100273
- "type": "array",
100274
- "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
100275
- "items": {
100276
- "type": "string"
100277
- }
100278
- },
100279
- "privacy": {
100280
- "type": "string",
100281
- "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`",
100282
- "enum": [
100283
- "secret",
100284
- "closed"
100285
- ]
100286
- },
100287
- "permission": {
100288
- "type": "string",
100289
- "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
100290
- "enum": [
100291
- "pull",
100292
- "push"
100293
- ],
100294
- "default": "pull"
100295
- },
100296
- "parent_team_id": {
100297
- "type": "integer",
100298
- "description": "The ID of a team to set as the parent team."
100299
- },
100300
- "ldap_dn": {
100301
- "type": "string",
100302
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\""
100303
- }
100304
- },
100305
- "required": [
100306
- "name"
100307
- ]
100308
- },
100309
- "examples": {
100310
- "default": {
100311
- "value": {
100312
- "name": "Justice League",
100313
- "description": "A great team",
100314
- "permission": "push",
100315
- "privacy": "closed"
100316
- }
100317
- }
100318
- }
100954
+ },
100955
+ {
100956
+ "name": "team_slug",
100957
+ "description": "The slug of the team name.",
100958
+ "in": "path",
100959
+ "required": true,
100960
+ "schema": {
100961
+ "type": "string"
100319
100962
  }
100320
100963
  }
100321
- },
100964
+ ],
100322
100965
  "responses": {
100323
- "201": {
100966
+ "200": {
100324
100967
  "description": "Response",
100325
100968
  "content": {
100326
100969
  "application/json": {
@@ -100818,8 +101461,8 @@
100818
101461
  }
100819
101462
  }
100820
101463
  },
100821
- "403": {
100822
- "description": "Forbidden",
101464
+ "404": {
101465
+ "description": "Resource not found",
100823
101466
  "content": {
100824
101467
  "application/json": {
100825
101468
  "schema": {
@@ -100843,75 +101486,6 @@
100843
101486
  }
100844
101487
  }
100845
101488
  }
100846
- },
100847
- "422": {
100848
- "description": "Validation failed",
100849
- "content": {
100850
- "application/json": {
100851
- "schema": {
100852
- "title": "Validation Error",
100853
- "description": "Validation Error",
100854
- "type": "object",
100855
- "required": [
100856
- "message",
100857
- "documentation_url"
100858
- ],
100859
- "properties": {
100860
- "message": {
100861
- "type": "string"
100862
- },
100863
- "documentation_url": {
100864
- "type": "string"
100865
- },
100866
- "errors": {
100867
- "type": "array",
100868
- "items": {
100869
- "type": "object",
100870
- "required": [
100871
- "code"
100872
- ],
100873
- "properties": {
100874
- "resource": {
100875
- "type": "string"
100876
- },
100877
- "field": {
100878
- "type": "string"
100879
- },
100880
- "message": {
100881
- "type": "string"
100882
- },
100883
- "code": {
100884
- "type": "string"
100885
- },
100886
- "index": {
100887
- "type": "integer"
100888
- },
100889
- "value": {
100890
- "oneOf": [
100891
- {
100892
- "type": "string",
100893
- "nullable": true
100894
- },
100895
- {
100896
- "type": "integer",
100897
- "nullable": true
100898
- },
100899
- {
100900
- "type": "array",
100901
- "nullable": true,
100902
- "items": {
100903
- "type": "string"
100904
- }
100905
- }
100906
- ]
100907
- }
100908
- }
100909
- }
100910
- }
100911
- }
100912
- }
100913
- }
100914
- }
100915
101489
  }
100916
101490
  },
100917
101491
  "x-github": {
@@ -100927,19 +101501,17 @@
100927
101501
  }
100928
101502
  }
100929
101503
  }
100930
- }
100931
- },
100932
- "/orgs/{org}/teams/{team_slug}": {
100933
- "get": {
100934
- "summary": "Get a team by name",
100935
- "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.",
101504
+ },
101505
+ "patch": {
101506
+ "summary": "Update a team",
101507
+ "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.",
100936
101508
  "tags": [
100937
101509
  "teams"
100938
101510
  ],
100939
- "operationId": "teams/get-by-name",
101511
+ "operationId": "teams/update-in-org",
100940
101512
  "externalDocs": {
100941
101513
  "description": "API method documentation",
100942
- "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#get-a-team-by-name"
101514
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#update-a-team"
100943
101515
  },
100944
101516
  "parameters": [
100945
101517
  {
@@ -100961,9 +101533,61 @@
100961
101533
  }
100962
101534
  }
100963
101535
  ],
101536
+ "requestBody": {
101537
+ "required": false,
101538
+ "content": {
101539
+ "application/json": {
101540
+ "schema": {
101541
+ "type": "object",
101542
+ "properties": {
101543
+ "name": {
101544
+ "type": "string",
101545
+ "description": "The name of the team."
101546
+ },
101547
+ "description": {
101548
+ "type": "string",
101549
+ "description": "The description of the team."
101550
+ },
101551
+ "privacy": {
101552
+ "type": "string",
101553
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.",
101554
+ "enum": [
101555
+ "secret",
101556
+ "closed"
101557
+ ]
101558
+ },
101559
+ "permission": {
101560
+ "type": "string",
101561
+ "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
101562
+ "enum": [
101563
+ "pull",
101564
+ "push",
101565
+ "admin"
101566
+ ],
101567
+ "default": "pull"
101568
+ },
101569
+ "parent_team_id": {
101570
+ "type": "integer",
101571
+ "description": "The ID of a team to set as the parent team.",
101572
+ "nullable": true
101573
+ }
101574
+ }
101575
+ },
101576
+ "examples": {
101577
+ "default": {
101578
+ "value": {
101579
+ "name": "new team name",
101580
+ "description": "new team description",
101581
+ "privacy": "closed"
101582
+ }
101583
+ }
101584
+ }
101585
+ }
101586
+ }
101587
+ },
100964
101588
  "responses": {
100965
101589
  "200": {
100966
- "description": "Response",
101590
+ "description": "Response when the updated information already exists",
100967
101591
  "content": {
100968
101592
  "application/json": {
100969
101593
  "schema": {
@@ -101460,131 +102084,6 @@
101460
102084
  }
101461
102085
  }
101462
102086
  },
101463
- "404": {
101464
- "description": "Resource not found",
101465
- "content": {
101466
- "application/json": {
101467
- "schema": {
101468
- "title": "Basic Error",
101469
- "description": "Basic Error",
101470
- "type": "object",
101471
- "properties": {
101472
- "message": {
101473
- "type": "string"
101474
- },
101475
- "documentation_url": {
101476
- "type": "string"
101477
- },
101478
- "url": {
101479
- "type": "string"
101480
- },
101481
- "status": {
101482
- "type": "string"
101483
- }
101484
- }
101485
- }
101486
- }
101487
- }
101488
- }
101489
- },
101490
- "x-github": {
101491
- "githubCloudOnly": false,
101492
- "enabledForGitHubApps": true,
101493
- "category": "teams",
101494
- "subcategory": null
101495
- },
101496
- "x-octokit": {
101497
- "diff": {
101498
- "ghes-3.6": {
101499
- "type": "changed"
101500
- }
101501
- }
101502
- }
101503
- },
101504
- "patch": {
101505
- "summary": "Update a team",
101506
- "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.",
101507
- "tags": [
101508
- "teams"
101509
- ],
101510
- "operationId": "teams/update-in-org",
101511
- "externalDocs": {
101512
- "description": "API method documentation",
101513
- "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#update-a-team"
101514
- },
101515
- "parameters": [
101516
- {
101517
- "name": "org",
101518
- "description": "The organization name. The name is not case sensitive.",
101519
- "in": "path",
101520
- "required": true,
101521
- "schema": {
101522
- "type": "string"
101523
- }
101524
- },
101525
- {
101526
- "name": "team_slug",
101527
- "description": "The slug of the team name.",
101528
- "in": "path",
101529
- "required": true,
101530
- "schema": {
101531
- "type": "string"
101532
- }
101533
- }
101534
- ],
101535
- "requestBody": {
101536
- "required": false,
101537
- "content": {
101538
- "application/json": {
101539
- "schema": {
101540
- "type": "object",
101541
- "properties": {
101542
- "name": {
101543
- "type": "string",
101544
- "description": "The name of the team."
101545
- },
101546
- "description": {
101547
- "type": "string",
101548
- "description": "The description of the team."
101549
- },
101550
- "privacy": {
101551
- "type": "string",
101552
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.",
101553
- "enum": [
101554
- "secret",
101555
- "closed"
101556
- ]
101557
- },
101558
- "permission": {
101559
- "type": "string",
101560
- "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
101561
- "enum": [
101562
- "pull",
101563
- "push",
101564
- "admin"
101565
- ],
101566
- "default": "pull"
101567
- },
101568
- "parent_team_id": {
101569
- "type": "integer",
101570
- "description": "The ID of a team to set as the parent team.",
101571
- "nullable": true
101572
- }
101573
- }
101574
- },
101575
- "examples": {
101576
- "default": {
101577
- "value": {
101578
- "name": "new team name",
101579
- "description": "new team description",
101580
- "privacy": "closed"
101581
- }
101582
- }
101583
- }
101584
- }
101585
- }
101586
- },
101587
- "responses": {
101588
102087
  "201": {
101589
102088
  "description": "Response",
101590
102089
  "content": {
@@ -102082,6 +102581,127 @@
102082
102581
  }
102083
102582
  }
102084
102583
  }
102584
+ },
102585
+ "403": {
102586
+ "description": "Forbidden",
102587
+ "content": {
102588
+ "application/json": {
102589
+ "schema": {
102590
+ "title": "Basic Error",
102591
+ "description": "Basic Error",
102592
+ "type": "object",
102593
+ "properties": {
102594
+ "message": {
102595
+ "type": "string"
102596
+ },
102597
+ "documentation_url": {
102598
+ "type": "string"
102599
+ },
102600
+ "url": {
102601
+ "type": "string"
102602
+ },
102603
+ "status": {
102604
+ "type": "string"
102605
+ }
102606
+ }
102607
+ }
102608
+ }
102609
+ }
102610
+ },
102611
+ "404": {
102612
+ "description": "Resource not found",
102613
+ "content": {
102614
+ "application/json": {
102615
+ "schema": {
102616
+ "title": "Basic Error",
102617
+ "description": "Basic Error",
102618
+ "type": "object",
102619
+ "properties": {
102620
+ "message": {
102621
+ "type": "string"
102622
+ },
102623
+ "documentation_url": {
102624
+ "type": "string"
102625
+ },
102626
+ "url": {
102627
+ "type": "string"
102628
+ },
102629
+ "status": {
102630
+ "type": "string"
102631
+ }
102632
+ }
102633
+ }
102634
+ }
102635
+ }
102636
+ },
102637
+ "422": {
102638
+ "description": "Validation failed",
102639
+ "content": {
102640
+ "application/json": {
102641
+ "schema": {
102642
+ "title": "Validation Error",
102643
+ "description": "Validation Error",
102644
+ "type": "object",
102645
+ "required": [
102646
+ "message",
102647
+ "documentation_url"
102648
+ ],
102649
+ "properties": {
102650
+ "message": {
102651
+ "type": "string"
102652
+ },
102653
+ "documentation_url": {
102654
+ "type": "string"
102655
+ },
102656
+ "errors": {
102657
+ "type": "array",
102658
+ "items": {
102659
+ "type": "object",
102660
+ "required": [
102661
+ "code"
102662
+ ],
102663
+ "properties": {
102664
+ "resource": {
102665
+ "type": "string"
102666
+ },
102667
+ "field": {
102668
+ "type": "string"
102669
+ },
102670
+ "message": {
102671
+ "type": "string"
102672
+ },
102673
+ "code": {
102674
+ "type": "string"
102675
+ },
102676
+ "index": {
102677
+ "type": "integer"
102678
+ },
102679
+ "value": {
102680
+ "oneOf": [
102681
+ {
102682
+ "type": "string",
102683
+ "nullable": true
102684
+ },
102685
+ {
102686
+ "type": "integer",
102687
+ "nullable": true
102688
+ },
102689
+ {
102690
+ "type": "array",
102691
+ "nullable": true,
102692
+ "items": {
102693
+ "type": "string"
102694
+ }
102695
+ }
102696
+ ]
102697
+ }
102698
+ }
102699
+ }
102700
+ }
102701
+ }
102702
+ }
102703
+ }
102704
+ }
102085
102705
  }
102086
102706
  },
102087
102707
  "x-github": {
@@ -123389,8 +124009,9 @@
123389
124009
  },
123390
124010
  "use_squash_pr_title_as_default": {
123391
124011
  "type": "boolean",
123392
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
123393
- "default": false
124012
+ "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.",
124013
+ "default": false,
124014
+ "deprecated": true
123394
124015
  },
123395
124016
  "squash_merge_commit_title": {
123396
124017
  "type": "string",
@@ -151059,7 +151680,7 @@
151059
151680
  },
151060
151681
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
151061
151682
  "get": {
151062
- "summary": "List workflow runs",
151683
+ "summary": "List workflow runs for a workflow",
151063
151684
  "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/enterprise-server@3.5/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.",
151064
151685
  "tags": [
151065
151686
  "actions"
@@ -212597,6 +213218,7 @@
212597
213218
  "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
212598
213219
  "in": "path",
212599
213220
  "required": true,
213221
+ "x-multi-segment": true,
212600
213222
  "schema": {
212601
213223
  "type": "string"
212602
213224
  }
@@ -216131,7 +216753,7 @@
216131
216753
  },
216132
216754
  "sha": {
216133
216755
  "type": "string",
216134
- "description": "The blob SHA of the file being replaced."
216756
+ "description": "The blob SHA of the file being deleted."
216135
216757
  },
216136
216758
  "branch": {
216137
216759
  "type": "string",
@@ -236975,7 +237597,7 @@
236975
237597
  "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
236976
237598
  "get": {
236977
237599
  "summary": "Get a tree",
236978
- "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.",
237600
+ "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.",
236979
237601
  "tags": [
236980
237602
  "git"
236981
237603
  ],