@octokit/openapi 7.12.0 → 7.13.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 (34) hide show
  1. package/generated/api.github.com.deref.json +767 -33
  2. package/generated/api.github.com.json +312 -24
  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 +33 -15
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +23 -14
  7. package/generated/ghes-3.2.deref.json +48 -30
  8. package/generated/ghes-3.2.json +33 -24
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +2 -2
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +2 -2
  11. package/generated/ghes-3.3.deref.json +49 -31
  12. package/generated/ghes-3.3.json +33 -24
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +8 -8
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +3 -3
  15. package/generated/ghes-3.4.deref.json +50 -32
  16. package/generated/ghes-3.4.json +33 -24
  17. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +11 -0
  18. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  19. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +19 -19
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.json +14 -14
  22. package/generated/ghes-3.5.deref.json +166 -33
  23. package/generated/ghes-3.5.json +139 -24
  24. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +6 -11
  25. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +3 -3
  26. package/generated/ghes-3.6-diff-to-api.github.com.json +2 -2
  27. package/generated/ghes-3.6.deref.json +815 -139
  28. package/generated/ghes-3.6.json +556 -130
  29. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +6 -0
  30. package/generated/github.ae-diff-to-api.github.com.deref.json +17 -17
  31. package/generated/github.ae-diff-to-api.github.com.json +14 -14
  32. package/generated/github.ae.deref.json +102 -31
  33. package/generated/github.ae.json +77 -24
  34. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.12.0",
4
+ "version": "7.13.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": {
@@ -33424,7 +33424,7 @@
33424
33424
  "description": "The REST API URL of the code locations for this alert."
33425
33425
  },
33426
33426
  "state": {
33427
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
33427
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
33428
33428
  "type": "string",
33429
33429
  "enum": [
33430
33430
  "open",
@@ -49720,7 +49720,7 @@
49720
49720
  },
49721
49721
  {
49722
49722
  "name": "state",
49723
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
49723
+ "description": "Indicates the state of the issues to return.",
49724
49724
  "in": "query",
49725
49725
  "required": false,
49726
49726
  "schema": {
@@ -49744,7 +49744,7 @@
49744
49744
  },
49745
49745
  {
49746
49746
  "name": "sort",
49747
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
49747
+ "description": "What to sort results by.",
49748
49748
  "in": "query",
49749
49749
  "required": false,
49750
49750
  "schema": {
@@ -53052,7 +53052,7 @@
53052
53052
  "type": "string"
53053
53053
  },
53054
53054
  "mode": {
53055
- "description": "The rendering mode. Can be either `markdown` or `gfm`.",
53055
+ "description": "The rendering mode.",
53056
53056
  "enum": [
53057
53057
  "markdown",
53058
53058
  "gfm"
@@ -82393,6 +82393,339 @@
82393
82393
  "x-octokit": {}
82394
82394
  }
82395
82395
  },
82396
+ "/orgs/{org}/external-group/{group_id}": {
82397
+ "get": {
82398
+ "summary": "Get an external group",
82399
+ "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
82400
+ "tags": [
82401
+ "teams"
82402
+ ],
82403
+ "operationId": "teams/external-idp-group-info-for-org",
82404
+ "externalDocs": {
82405
+ "description": "API method documentation",
82406
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#external-idp-group-info-for-an-organization"
82407
+ },
82408
+ "parameters": [
82409
+ {
82410
+ "name": "org",
82411
+ "description": "The organization name. The name is not case sensitive.",
82412
+ "in": "path",
82413
+ "required": true,
82414
+ "schema": {
82415
+ "type": "string"
82416
+ }
82417
+ },
82418
+ {
82419
+ "name": "group_id",
82420
+ "description": "The unique identifier of the group.",
82421
+ "in": "path",
82422
+ "required": true,
82423
+ "schema": {
82424
+ "type": "integer"
82425
+ }
82426
+ }
82427
+ ],
82428
+ "responses": {
82429
+ "200": {
82430
+ "description": "Response",
82431
+ "content": {
82432
+ "application/json": {
82433
+ "schema": {
82434
+ "title": "ExternalGroup",
82435
+ "description": "Information about an external group's usage and its members",
82436
+ "type": "object",
82437
+ "required": [
82438
+ "group_id",
82439
+ "group_name",
82440
+ "teams",
82441
+ "members"
82442
+ ],
82443
+ "properties": {
82444
+ "group_id": {
82445
+ "description": "The internal ID of the group",
82446
+ "example": 1,
82447
+ "type": "integer"
82448
+ },
82449
+ "group_name": {
82450
+ "description": "The display name for the group",
82451
+ "example": "group-azuread-test",
82452
+ "type": "string"
82453
+ },
82454
+ "updated_at": {
82455
+ "description": "The date when the group was last updated_at",
82456
+ "example": "2021-01-03 22:27:15:000 -700",
82457
+ "type": "string"
82458
+ },
82459
+ "teams": {
82460
+ "description": "An array of teams linked to this group",
82461
+ "example": [
82462
+ {
82463
+ "team_id": 1,
82464
+ "team_name": "team-test"
82465
+ },
82466
+ {
82467
+ "team_id": 2,
82468
+ "team_name": "team-test2"
82469
+ }
82470
+ ],
82471
+ "type": "array",
82472
+ "items": {
82473
+ "type": "object",
82474
+ "required": [
82475
+ "team_id",
82476
+ "team_name"
82477
+ ],
82478
+ "properties": {
82479
+ "team_id": {
82480
+ "description": "The id for a team",
82481
+ "example": 1,
82482
+ "type": "integer"
82483
+ },
82484
+ "team_name": {
82485
+ "description": "The name of the team",
82486
+ "example": "team-test",
82487
+ "type": "string"
82488
+ }
82489
+ }
82490
+ }
82491
+ },
82492
+ "members": {
82493
+ "description": "An array of external members linked to this group",
82494
+ "example": [
82495
+ {
82496
+ "member_id": 1,
82497
+ "member_login": "mona-lisa_eocsaxrs",
82498
+ "member_name": "Mona Lisa",
82499
+ "member_email": "mona_lisa@github.com"
82500
+ },
82501
+ {
82502
+ "member_id": 2,
82503
+ "member_login": "octo-lisa_eocsaxrs",
82504
+ "member_name": "Octo Lisa",
82505
+ "member_email": "octo_lisa@github.com"
82506
+ }
82507
+ ],
82508
+ "type": "array",
82509
+ "items": {
82510
+ "type": "object",
82511
+ "required": [
82512
+ "member_id",
82513
+ "member_login",
82514
+ "member_name",
82515
+ "member_email"
82516
+ ],
82517
+ "properties": {
82518
+ "member_id": {
82519
+ "description": "The internal user ID of the identity",
82520
+ "example": 1,
82521
+ "type": "integer"
82522
+ },
82523
+ "member_login": {
82524
+ "description": "The handle/login for the user",
82525
+ "example": "mona-lisa_eocsaxrs",
82526
+ "type": "string"
82527
+ },
82528
+ "member_name": {
82529
+ "description": "The user display name/profile name",
82530
+ "example": "Mona Lisa",
82531
+ "type": "string"
82532
+ },
82533
+ "member_email": {
82534
+ "description": "An email attached to a user",
82535
+ "example": "mona_lisa@github.com",
82536
+ "type": "string"
82537
+ }
82538
+ }
82539
+ }
82540
+ }
82541
+ }
82542
+ },
82543
+ "examples": {
82544
+ "default": {
82545
+ "value": {
82546
+ "group_id": "123",
82547
+ "group_name": "Octocat admins",
82548
+ "updated_at": "2021-01-24T11:31:04-06:00",
82549
+ "teams": [
82550
+ {
82551
+ "team_id": 1,
82552
+ "team_name": "team-test"
82553
+ },
82554
+ {
82555
+ "team_id": 2,
82556
+ "team_name": "team-test2"
82557
+ }
82558
+ ],
82559
+ "members": [
82560
+ {
82561
+ "member_id": 1,
82562
+ "member_login": "mona-lisa_eocsaxrs",
82563
+ "member_name": "Mona Lisa",
82564
+ "member_email": "mona_lisa@github.com"
82565
+ },
82566
+ {
82567
+ "member_id": 2,
82568
+ "member_login": "octo-lisa_eocsaxrs",
82569
+ "member_name": "Octo Lisa",
82570
+ "member_email": "octo_lisa@github.com"
82571
+ }
82572
+ ]
82573
+ }
82574
+ }
82575
+ }
82576
+ }
82577
+ }
82578
+ }
82579
+ },
82580
+ "x-github": {
82581
+ "githubCloudOnly": true,
82582
+ "enabledForGitHubApps": true,
82583
+ "category": "teams",
82584
+ "subcategory": "external-groups"
82585
+ },
82586
+ "x-octokit": {}
82587
+ }
82588
+ },
82589
+ "/orgs/{org}/external-groups": {
82590
+ "get": {
82591
+ "summary": "List external groups in an organization",
82592
+ "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
82593
+ "tags": [
82594
+ "teams"
82595
+ ],
82596
+ "operationId": "teams/list-external-idp-groups-for-org",
82597
+ "externalDocs": {
82598
+ "description": "API method documentation",
82599
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-groups-for-an-organization"
82600
+ },
82601
+ "parameters": [
82602
+ {
82603
+ "name": "org",
82604
+ "description": "The organization name. The name is not case sensitive.",
82605
+ "in": "path",
82606
+ "required": true,
82607
+ "schema": {
82608
+ "type": "string"
82609
+ }
82610
+ },
82611
+ {
82612
+ "name": "per_page",
82613
+ "description": "The number of results per page (max 100).",
82614
+ "in": "query",
82615
+ "schema": {
82616
+ "type": "integer",
82617
+ "default": 30
82618
+ }
82619
+ },
82620
+ {
82621
+ "name": "page",
82622
+ "description": "Page token",
82623
+ "in": "query",
82624
+ "schema": {
82625
+ "type": "integer"
82626
+ }
82627
+ },
82628
+ {
82629
+ "name": "display_name",
82630
+ "description": "Limits the list to groups containing the text in the group name",
82631
+ "in": "query",
82632
+ "schema": {
82633
+ "type": "string"
82634
+ }
82635
+ }
82636
+ ],
82637
+ "responses": {
82638
+ "200": {
82639
+ "description": "Response",
82640
+ "content": {
82641
+ "application/json": {
82642
+ "schema": {
82643
+ "title": "ExternalGroups",
82644
+ "description": "A list of external groups available to be connected to a team",
82645
+ "type": "object",
82646
+ "properties": {
82647
+ "groups": {
82648
+ "description": "An array of external groups available to be mapped to a team",
82649
+ "example": [
82650
+ {
82651
+ "group_id": 1,
82652
+ "group_name": "group-azuread-test",
82653
+ "updated_at": "2021-01-03 22:27:15:000 -700"
82654
+ },
82655
+ {
82656
+ "group_id": 2,
82657
+ "group_name": "group-azuread-test2",
82658
+ "updated_at": "2021-06-03 22:27:15:000 -700"
82659
+ }
82660
+ ],
82661
+ "type": "array",
82662
+ "items": {
82663
+ "type": "object",
82664
+ "required": [
82665
+ "group_id",
82666
+ "group_name",
82667
+ "updated_at"
82668
+ ],
82669
+ "properties": {
82670
+ "group_id": {
82671
+ "description": "The internal ID of the group",
82672
+ "example": 1,
82673
+ "type": "integer"
82674
+ },
82675
+ "group_name": {
82676
+ "description": "The display name of the group",
82677
+ "example": "group-azuread-test",
82678
+ "type": "string"
82679
+ },
82680
+ "updated_at": {
82681
+ "description": "The time of the last update for this group",
82682
+ "example": "2019-06-03 22:27:15:000 -700",
82683
+ "type": "string"
82684
+ }
82685
+ }
82686
+ }
82687
+ }
82688
+ }
82689
+ },
82690
+ "examples": {
82691
+ "default": {
82692
+ "value": {
82693
+ "groups": [
82694
+ {
82695
+ "group_id": "123",
82696
+ "group_name": "Octocat admins",
82697
+ "updated_at": "2021-01-24T11:31:04-06:00"
82698
+ },
82699
+ {
82700
+ "group_id": "456",
82701
+ "group_name": "Octocat docs members",
82702
+ "updated_at": "2021-03-24T11:31:04-06:00"
82703
+ }
82704
+ ]
82705
+ }
82706
+ }
82707
+ }
82708
+ }
82709
+ },
82710
+ "headers": {
82711
+ "Link": {
82712
+ "example": "<https://api.github.com/resource?per_page=2&page=url-encoded-next-page-token>; rel=\"next\"",
82713
+ "schema": {
82714
+ "type": "string"
82715
+ }
82716
+ }
82717
+ }
82718
+ }
82719
+ },
82720
+ "x-github": {
82721
+ "githubCloudOnly": true,
82722
+ "enabledForGitHubApps": true,
82723
+ "category": "teams",
82724
+ "subcategory": "external-groups"
82725
+ },
82726
+ "x-octokit": {}
82727
+ }
82728
+ },
82396
82729
  "/orgs/{org}/hooks": {
82397
82730
  "get": {
82398
82731
  "summary": "List organization webhooks",
@@ -86368,7 +86701,7 @@
86368
86701
  },
86369
86702
  {
86370
86703
  "name": "state",
86371
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
86704
+ "description": "Indicates the state of the issues to return.",
86372
86705
  "in": "query",
86373
86706
  "required": false,
86374
86707
  "schema": {
@@ -86392,7 +86725,7 @@
86392
86725
  },
86393
86726
  {
86394
86727
  "name": "sort",
86395
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
86728
+ "description": "What to sort results by.",
86396
86729
  "in": "query",
86397
86730
  "required": false,
86398
86731
  "schema": {
@@ -96536,7 +96869,7 @@
96536
96869
  },
96537
96870
  {
96538
96871
  "name": "state",
96539
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
96872
+ "description": "Indicates the state of the projects to return.",
96540
96873
  "in": "query",
96541
96874
  "required": false,
96542
96875
  "schema": {
@@ -101475,7 +101808,7 @@
101475
101808
  "description": "The REST API URL of the code locations for this alert."
101476
101809
  },
101477
101810
  "state": {
101478
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
101811
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
101479
101812
  "type": "string",
101480
101813
  "enum": [
101481
101814
  "open",
@@ -110453,6 +110786,384 @@
110453
110786
  "x-octokit": {}
110454
110787
  }
110455
110788
  },
110789
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
110790
+ "get": {
110791
+ "summary": "List a connection between an external group and a team",
110792
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
110793
+ "tags": [
110794
+ "teams"
110795
+ ],
110796
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
110797
+ "externalDocs": {
110798
+ "description": "API method documentation",
110799
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-group-team-connection"
110800
+ },
110801
+ "parameters": [
110802
+ {
110803
+ "name": "org",
110804
+ "description": "The organization name. The name is not case sensitive.",
110805
+ "in": "path",
110806
+ "required": true,
110807
+ "schema": {
110808
+ "type": "string"
110809
+ }
110810
+ },
110811
+ {
110812
+ "name": "team_slug",
110813
+ "description": "The slug of the team name.",
110814
+ "in": "path",
110815
+ "required": true,
110816
+ "schema": {
110817
+ "type": "string"
110818
+ }
110819
+ }
110820
+ ],
110821
+ "responses": {
110822
+ "200": {
110823
+ "description": "Response",
110824
+ "content": {
110825
+ "application/json": {
110826
+ "schema": {
110827
+ "title": "ExternalGroups",
110828
+ "description": "A list of external groups available to be connected to a team",
110829
+ "type": "object",
110830
+ "properties": {
110831
+ "groups": {
110832
+ "description": "An array of external groups available to be mapped to a team",
110833
+ "example": [
110834
+ {
110835
+ "group_id": 1,
110836
+ "group_name": "group-azuread-test",
110837
+ "updated_at": "2021-01-03 22:27:15:000 -700"
110838
+ },
110839
+ {
110840
+ "group_id": 2,
110841
+ "group_name": "group-azuread-test2",
110842
+ "updated_at": "2021-06-03 22:27:15:000 -700"
110843
+ }
110844
+ ],
110845
+ "type": "array",
110846
+ "items": {
110847
+ "type": "object",
110848
+ "required": [
110849
+ "group_id",
110850
+ "group_name",
110851
+ "updated_at"
110852
+ ],
110853
+ "properties": {
110854
+ "group_id": {
110855
+ "description": "The internal ID of the group",
110856
+ "example": 1,
110857
+ "type": "integer"
110858
+ },
110859
+ "group_name": {
110860
+ "description": "The display name of the group",
110861
+ "example": "group-azuread-test",
110862
+ "type": "string"
110863
+ },
110864
+ "updated_at": {
110865
+ "description": "The time of the last update for this group",
110866
+ "example": "2019-06-03 22:27:15:000 -700",
110867
+ "type": "string"
110868
+ }
110869
+ }
110870
+ }
110871
+ }
110872
+ }
110873
+ },
110874
+ "examples": {
110875
+ "default": {
110876
+ "value": {
110877
+ "groups": [
110878
+ {
110879
+ "group_id": "123",
110880
+ "group_name": "Octocat admins",
110881
+ "updated_at": "2021-01-24T11:31:04-06:00"
110882
+ },
110883
+ {
110884
+ "group_id": "456",
110885
+ "group_name": "Octocat docs members",
110886
+ "updated_at": "2021-03-24T11:31:04-06:00"
110887
+ }
110888
+ ]
110889
+ }
110890
+ }
110891
+ }
110892
+ }
110893
+ }
110894
+ }
110895
+ },
110896
+ "x-github": {
110897
+ "githubCloudOnly": true,
110898
+ "enabledForGitHubApps": true,
110899
+ "category": "teams",
110900
+ "subcategory": "external-groups"
110901
+ },
110902
+ "x-octokit": {}
110903
+ },
110904
+ "patch": {
110905
+ "summary": "Update the connection between an external group and a team",
110906
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
110907
+ "tags": [
110908
+ "teams"
110909
+ ],
110910
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
110911
+ "externalDocs": {
110912
+ "description": "API method documentation",
110913
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#link-external-idp-group-team-connection"
110914
+ },
110915
+ "parameters": [
110916
+ {
110917
+ "name": "org",
110918
+ "description": "The organization name. The name is not case sensitive.",
110919
+ "in": "path",
110920
+ "required": true,
110921
+ "schema": {
110922
+ "type": "string"
110923
+ }
110924
+ },
110925
+ {
110926
+ "name": "team_slug",
110927
+ "description": "The slug of the team name.",
110928
+ "in": "path",
110929
+ "required": true,
110930
+ "schema": {
110931
+ "type": "string"
110932
+ }
110933
+ }
110934
+ ],
110935
+ "requestBody": {
110936
+ "required": true,
110937
+ "content": {
110938
+ "application/json": {
110939
+ "schema": {
110940
+ "type": "object",
110941
+ "properties": {
110942
+ "group_id": {
110943
+ "type": "integer",
110944
+ "description": "External Group Id",
110945
+ "example": 1
110946
+ }
110947
+ },
110948
+ "required": [
110949
+ "group_id"
110950
+ ]
110951
+ },
110952
+ "examples": {
110953
+ "default": {
110954
+ "value": {
110955
+ "group_id": 123
110956
+ }
110957
+ }
110958
+ }
110959
+ }
110960
+ }
110961
+ },
110962
+ "responses": {
110963
+ "200": {
110964
+ "description": "Response",
110965
+ "content": {
110966
+ "application/json": {
110967
+ "schema": {
110968
+ "title": "ExternalGroup",
110969
+ "description": "Information about an external group's usage and its members",
110970
+ "type": "object",
110971
+ "required": [
110972
+ "group_id",
110973
+ "group_name",
110974
+ "teams",
110975
+ "members"
110976
+ ],
110977
+ "properties": {
110978
+ "group_id": {
110979
+ "description": "The internal ID of the group",
110980
+ "example": 1,
110981
+ "type": "integer"
110982
+ },
110983
+ "group_name": {
110984
+ "description": "The display name for the group",
110985
+ "example": "group-azuread-test",
110986
+ "type": "string"
110987
+ },
110988
+ "updated_at": {
110989
+ "description": "The date when the group was last updated_at",
110990
+ "example": "2021-01-03 22:27:15:000 -700",
110991
+ "type": "string"
110992
+ },
110993
+ "teams": {
110994
+ "description": "An array of teams linked to this group",
110995
+ "example": [
110996
+ {
110997
+ "team_id": 1,
110998
+ "team_name": "team-test"
110999
+ },
111000
+ {
111001
+ "team_id": 2,
111002
+ "team_name": "team-test2"
111003
+ }
111004
+ ],
111005
+ "type": "array",
111006
+ "items": {
111007
+ "type": "object",
111008
+ "required": [
111009
+ "team_id",
111010
+ "team_name"
111011
+ ],
111012
+ "properties": {
111013
+ "team_id": {
111014
+ "description": "The id for a team",
111015
+ "example": 1,
111016
+ "type": "integer"
111017
+ },
111018
+ "team_name": {
111019
+ "description": "The name of the team",
111020
+ "example": "team-test",
111021
+ "type": "string"
111022
+ }
111023
+ }
111024
+ }
111025
+ },
111026
+ "members": {
111027
+ "description": "An array of external members linked to this group",
111028
+ "example": [
111029
+ {
111030
+ "member_id": 1,
111031
+ "member_login": "mona-lisa_eocsaxrs",
111032
+ "member_name": "Mona Lisa",
111033
+ "member_email": "mona_lisa@github.com"
111034
+ },
111035
+ {
111036
+ "member_id": 2,
111037
+ "member_login": "octo-lisa_eocsaxrs",
111038
+ "member_name": "Octo Lisa",
111039
+ "member_email": "octo_lisa@github.com"
111040
+ }
111041
+ ],
111042
+ "type": "array",
111043
+ "items": {
111044
+ "type": "object",
111045
+ "required": [
111046
+ "member_id",
111047
+ "member_login",
111048
+ "member_name",
111049
+ "member_email"
111050
+ ],
111051
+ "properties": {
111052
+ "member_id": {
111053
+ "description": "The internal user ID of the identity",
111054
+ "example": 1,
111055
+ "type": "integer"
111056
+ },
111057
+ "member_login": {
111058
+ "description": "The handle/login for the user",
111059
+ "example": "mona-lisa_eocsaxrs",
111060
+ "type": "string"
111061
+ },
111062
+ "member_name": {
111063
+ "description": "The user display name/profile name",
111064
+ "example": "Mona Lisa",
111065
+ "type": "string"
111066
+ },
111067
+ "member_email": {
111068
+ "description": "An email attached to a user",
111069
+ "example": "mona_lisa@github.com",
111070
+ "type": "string"
111071
+ }
111072
+ }
111073
+ }
111074
+ }
111075
+ }
111076
+ },
111077
+ "examples": {
111078
+ "default": {
111079
+ "value": {
111080
+ "group_id": "123",
111081
+ "group_name": "Octocat admins",
111082
+ "updated_at": "2021-01-24T11:31:04-06:00",
111083
+ "teams": [
111084
+ {
111085
+ "team_id": 1,
111086
+ "team_name": "team-test"
111087
+ },
111088
+ {
111089
+ "team_id": 2,
111090
+ "team_name": "team-test2"
111091
+ }
111092
+ ],
111093
+ "members": [
111094
+ {
111095
+ "member_id": 1,
111096
+ "member_login": "mona-lisa_eocsaxrs",
111097
+ "member_name": "Mona Lisa",
111098
+ "member_email": "mona_lisa@github.com"
111099
+ },
111100
+ {
111101
+ "member_id": 2,
111102
+ "member_login": "octo-lisa_eocsaxrs",
111103
+ "member_name": "Octo Lisa",
111104
+ "member_email": "octo_lisa@github.com"
111105
+ }
111106
+ ]
111107
+ }
111108
+ }
111109
+ }
111110
+ }
111111
+ }
111112
+ }
111113
+ },
111114
+ "x-github": {
111115
+ "githubCloudOnly": true,
111116
+ "enabledForGitHubApps": false,
111117
+ "category": "teams",
111118
+ "subcategory": "external-groups"
111119
+ },
111120
+ "x-octokit": {}
111121
+ },
111122
+ "delete": {
111123
+ "summary": "Remove the connection between an external group and a team",
111124
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
111125
+ "tags": [
111126
+ "teams"
111127
+ ],
111128
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
111129
+ "externalDocs": {
111130
+ "description": "API method documentation",
111131
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#unlink-external-idp-group-team-connection"
111132
+ },
111133
+ "parameters": [
111134
+ {
111135
+ "name": "org",
111136
+ "description": "The organization name. The name is not case sensitive.",
111137
+ "in": "path",
111138
+ "required": true,
111139
+ "schema": {
111140
+ "type": "string"
111141
+ }
111142
+ },
111143
+ {
111144
+ "name": "team_slug",
111145
+ "description": "The slug of the team name.",
111146
+ "in": "path",
111147
+ "required": true,
111148
+ "schema": {
111149
+ "type": "string"
111150
+ }
111151
+ }
111152
+ ],
111153
+ "responses": {
111154
+ "204": {
111155
+ "description": "Response"
111156
+ }
111157
+ },
111158
+ "x-github": {
111159
+ "githubCloudOnly": true,
111160
+ "enabledForGitHubApps": false,
111161
+ "category": "teams",
111162
+ "subcategory": "external-groups"
111163
+ },
111164
+ "x-octokit": {}
111165
+ }
111166
+ },
110456
111167
  "/orgs/{org}/teams/{team_slug}/members": {
110457
111168
  "get": {
110458
111169
  "summary": "List team members",
@@ -133390,7 +134101,16 @@
133390
134101
  "description": "The outcome of the job.",
133391
134102
  "example": "success",
133392
134103
  "type": "string",
133393
- "nullable": true
134104
+ "nullable": true,
134105
+ "enum": [
134106
+ "success",
134107
+ "failure",
134108
+ "neutral",
134109
+ "cancelled",
134110
+ "skipped",
134111
+ "timed_out",
134112
+ "action_required"
134113
+ ]
133394
134114
  },
133395
134115
  "started_at": {
133396
134116
  "description": "The time that the job started, in ISO 8601 format.",
@@ -152706,7 +153426,16 @@
152706
153426
  "description": "The outcome of the job.",
152707
153427
  "example": "success",
152708
153428
  "type": "string",
152709
- "nullable": true
153429
+ "nullable": true,
153430
+ "enum": [
153431
+ "success",
153432
+ "failure",
153433
+ "neutral",
153434
+ "cancelled",
153435
+ "skipped",
153436
+ "timed_out",
153437
+ "action_required"
153438
+ ]
152710
153439
  },
152711
153440
  "started_at": {
152712
153441
  "description": "The time that the job started, in ISO 8601 format.",
@@ -153322,7 +154051,16 @@
153322
154051
  "description": "The outcome of the job.",
153323
154052
  "example": "success",
153324
154053
  "type": "string",
153325
- "nullable": true
154054
+ "nullable": true,
154055
+ "enum": [
154056
+ "success",
154057
+ "failure",
154058
+ "neutral",
154059
+ "cancelled",
154060
+ "skipped",
154061
+ "timed_out",
154062
+ "action_required"
154063
+ ]
153326
154064
  },
153327
154065
  "started_at": {
153328
154066
  "description": "The time that the job started, in ISO 8601 format.",
@@ -198181,7 +198919,7 @@
198181
198919
  }
198182
198920
  },
198183
198921
  "403": {
198184
- "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
198922
+ "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
198185
198923
  "content": {
198186
198924
  "application/json": {
198187
198925
  "schema": {
@@ -199383,7 +200121,7 @@
199383
200121
  }
199384
200122
  },
199385
200123
  "403": {
199386
- "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
200124
+ "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
199387
200125
  "content": {
199388
200126
  "application/json": {
199389
200127
  "schema": {
@@ -199589,7 +200327,7 @@
199589
200327
  "description": "Bad Request if the sarif field is invalid"
199590
200328
  },
199591
200329
  "403": {
199592
- "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
200330
+ "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
199593
200331
  "content": {
199594
200332
  "application/json": {
199595
200333
  "schema": {
@@ -221427,7 +222165,7 @@
221427
222165
  },
221428
222166
  "put": {
221429
222167
  "summary": "Create or update file contents",
221430
- "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
222168
+ "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
221431
222169
  "tags": [
221432
222170
  "repos"
221433
222171
  ],
@@ -222132,7 +222870,7 @@
222132
222870
  },
222133
222871
  "delete": {
222134
222872
  "summary": "Delete a file",
222135
- "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
222873
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
222136
222874
  "tags": [
222137
222875
  "repos"
222138
222876
  ],
@@ -233492,7 +234230,7 @@
233492
234230
  },
233493
234231
  {
233494
234232
  "name": "sort",
233495
- "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
234233
+ "description": "The sort order. `stargazers` will sort by star count.",
233496
234234
  "in": "query",
233497
234235
  "required": false,
233498
234236
  "schema": {
@@ -252375,7 +253113,7 @@
252375
253113
  },
252376
253114
  {
252377
253115
  "name": "state",
252378
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
253116
+ "description": "Indicates the state of the issues to return.",
252379
253117
  "in": "query",
252380
253118
  "required": false,
252381
253119
  "schema": {
@@ -252426,7 +253164,7 @@
252426
253164
  },
252427
253165
  {
252428
253166
  "name": "sort",
252429
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
253167
+ "description": "What to sort results by.",
252430
253168
  "in": "query",
252431
253169
  "required": false,
252432
253170
  "schema": {
@@ -312812,7 +313550,7 @@
312812
313550
  },
312813
313551
  {
312814
313552
  "name": "state",
312815
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
313553
+ "description": "Indicates the state of the projects to return.",
312816
313554
  "in": "query",
312817
313555
  "required": false,
312818
313556
  "schema": {
@@ -313792,7 +314530,7 @@
313792
314530
  },
313793
314531
  {
313794
314532
  "name": "sort",
313795
- "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
314533
+ "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
313796
314534
  "in": "query",
313797
314535
  "required": false,
313798
314536
  "schema": {
@@ -313808,7 +314546,7 @@
313808
314546
  },
313809
314547
  {
313810
314548
  "name": "direction",
313811
- "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
314549
+ "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
313812
314550
  "in": "query",
313813
314551
  "required": false,
313814
314552
  "schema": {
@@ -321958,7 +322696,7 @@
321958
322696
  },
321959
322697
  {
321960
322698
  "name": "direction",
321961
- "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
322699
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
321962
322700
  "in": "query",
321963
322701
  "required": false,
321964
322702
  "schema": {
@@ -331395,7 +332133,7 @@
331395
332133
  },
331396
332134
  {
331397
332135
  "name": "direction",
331398
- "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
332136
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
331399
332137
  "in": "query",
331400
332138
  "required": false,
331401
332139
  "schema": {
@@ -355296,7 +356034,7 @@
355296
356034
  "description": "The REST API URL of the code locations for this alert."
355297
356035
  },
355298
356036
  "state": {
355299
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
356037
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
355300
356038
  "type": "string",
355301
356039
  "enum": [
355302
356040
  "open",
@@ -355794,7 +356532,7 @@
355794
356532
  "description": "The REST API URL of the code locations for this alert."
355795
356533
  },
355796
356534
  "state": {
355797
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
356535
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
355798
356536
  "type": "string",
355799
356537
  "enum": [
355800
356538
  "open",
@@ -356194,7 +356932,7 @@
356194
356932
  "type": "object",
356195
356933
  "properties": {
356196
356934
  "state": {
356197
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
356935
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
356198
356936
  "type": "string",
356199
356937
  "enum": [
356200
356938
  "open",
@@ -356272,7 +357010,7 @@
356272
357010
  "description": "The REST API URL of the code locations for this alert."
356273
357011
  },
356274
357012
  "state": {
356275
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
357013
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
356276
357014
  "type": "string",
356277
357015
  "enum": [
356278
357016
  "open",
@@ -396434,7 +397172,7 @@
396434
397172
  },
396435
397173
  {
396436
397174
  "name": "state",
396437
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
397175
+ "description": "Indicates the state of the issues to return.",
396438
397176
  "in": "query",
396439
397177
  "required": false,
396440
397178
  "schema": {
@@ -396458,7 +397196,7 @@
396458
397196
  },
396459
397197
  {
396460
397198
  "name": "sort",
396461
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
397199
+ "description": "What to sort results by.",
396462
397200
  "in": "query",
396463
397201
  "required": false,
396464
397202
  "schema": {
@@ -400063,7 +400801,7 @@
400063
400801
  "parameters": [
400064
400802
  {
400065
400803
  "name": "state",
400066
- "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
400804
+ "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
400067
400805
  "in": "query",
400068
400806
  "required": false,
400069
400807
  "schema": {
@@ -432513,7 +433251,7 @@
432513
433251
  },
432514
433252
  {
432515
433253
  "name": "state",
432516
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
433254
+ "description": "Indicates the state of the projects to return.",
432517
433255
  "in": "query",
432518
433256
  "required": false,
432519
433257
  "schema": {
@@ -448651,50 +449389,6 @@
448651
449389
  }
448652
449390
  }
448653
449391
  },
448654
- "/orgs/{org}/external-group/{group_id}": {
448655
- "get": {
448656
- "summary": "Get an external group",
448657
- "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
448658
- "tags": [
448659
- "teams"
448660
- ],
448661
- "operationId": "teams/external-idp-group-info-for-org",
448662
- "externalDocs": {
448663
- "description": "API method documentation",
448664
- "url": "https://docs.github.com/rest/reference/teams#external-idp-group-info-for-an-organization"
448665
- },
448666
- "x-octokit": {
448667
- "api.github.com": "removed"
448668
- },
448669
- "responses": {
448670
- "501": {
448671
- "description": "Not Implemented"
448672
- }
448673
- }
448674
- }
448675
- },
448676
- "/orgs/{org}/external-groups": {
448677
- "get": {
448678
- "summary": "List external groups in an organization",
448679
- "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
448680
- "tags": [
448681
- "teams"
448682
- ],
448683
- "operationId": "teams/list-external-idp-groups-for-org",
448684
- "externalDocs": {
448685
- "description": "API method documentation",
448686
- "url": "https://docs.github.com/rest/reference/teams#list-external-idp-groups-for-an-organization"
448687
- },
448688
- "x-octokit": {
448689
- "api.github.com": "removed"
448690
- },
448691
- "responses": {
448692
- "501": {
448693
- "description": "Not Implemented"
448694
- }
448695
- }
448696
- }
448697
- },
448698
449392
  "/orgs/{org}/failed_invitations": {
448699
449393
  "get": {
448700
449394
  "summary": "List failed organization invitations",
@@ -449341,68 +450035,6 @@
449341
450035
  }
449342
450036
  }
449343
450037
  },
449344
- "/orgs/{org}/teams/{team_slug}/external-groups": {
449345
- "get": {
449346
- "summary": "List a connection between an external group and a team",
449347
- "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
449348
- "tags": [
449349
- "teams"
449350
- ],
449351
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
449352
- "externalDocs": {
449353
- "description": "API method documentation",
449354
- "url": "https://docs.github.com/rest/reference/teams#list-external-idp-group-team-connection"
449355
- },
449356
- "x-octokit": {
449357
- "api.github.com": "removed"
449358
- },
449359
- "responses": {
449360
- "501": {
449361
- "description": "Not Implemented"
449362
- }
449363
- }
449364
- },
449365
- "delete": {
449366
- "summary": "Remove the connection between an external group and a team",
449367
- "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
449368
- "tags": [
449369
- "teams"
449370
- ],
449371
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
449372
- "externalDocs": {
449373
- "description": "API method documentation",
449374
- "url": "https://docs.github.com/rest/reference/teams#unlink-external-idp-group-team-connection"
449375
- },
449376
- "x-octokit": {
449377
- "api.github.com": "removed"
449378
- },
449379
- "responses": {
449380
- "501": {
449381
- "description": "Not Implemented"
449382
- }
449383
- }
449384
- },
449385
- "patch": {
449386
- "summary": "Update the connection between an external group and a team",
449387
- "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
449388
- "tags": [
449389
- "teams"
449390
- ],
449391
- "operationId": "teams/link-external-idp-group-to-team-for-org",
449392
- "externalDocs": {
449393
- "description": "API method documentation",
449394
- "url": "https://docs.github.com/rest/reference/teams#link-external-idp-group-team-connection"
449395
- },
449396
- "x-octokit": {
449397
- "api.github.com": "removed"
449398
- },
449399
- "responses": {
449400
- "501": {
449401
- "description": "Not Implemented"
449402
- }
449403
- }
449404
- }
449405
- },
449406
450038
  "/orgs/{org}/teams/{team_slug}/invitations": {
449407
450039
  "get": {
449408
450040
  "summary": "List pending team invitations",
@@ -449703,6 +450335,50 @@
449703
450335
  }
449704
450336
  }
449705
450337
  },
450338
+ "/repos/{owner}/{repo}/code-scanning/codeql/databases": {
450339
+ "get": {
450340
+ "summary": "List CodeQL databases for a repository",
450341
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450342
+ "tags": [
450343
+ "code-scanning"
450344
+ ],
450345
+ "operationId": "code-scanning/list-codeql-databases",
450346
+ "externalDocs": {
450347
+ "description": "API method documentation",
450348
+ "url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
450349
+ },
450350
+ "x-octokit": {
450351
+ "api.github.com": "removed"
450352
+ },
450353
+ "responses": {
450354
+ "501": {
450355
+ "description": "Not Implemented"
450356
+ }
450357
+ }
450358
+ }
450359
+ },
450360
+ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
450361
+ "get": {
450362
+ "summary": "Get a CodeQL database for a repository",
450363
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450364
+ "tags": [
450365
+ "code-scanning"
450366
+ ],
450367
+ "operationId": "code-scanning/get-codeql-database",
450368
+ "externalDocs": {
450369
+ "description": "API method documentation",
450370
+ "url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
450371
+ },
450372
+ "x-octokit": {
450373
+ "api.github.com": "removed"
450374
+ },
450375
+ "responses": {
450376
+ "501": {
450377
+ "description": "Not Implemented"
450378
+ }
450379
+ }
450380
+ }
450381
+ },
449706
450382
  "/repos/{owner}/{repo}/codespaces": {
449707
450383
  "get": {
449708
450384
  "summary": "List codespaces in a repository for the authenticated user",