@octokit/openapi 7.5.0 → 7.6.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 +466 -140
  2. package/generated/api.github.com.json +607 -28
  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 +31 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -14
  7. package/generated/ghes-3.2.deref.json +319 -242
  8. package/generated/ghes-3.2.json +558 -26
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -16
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +187 -223
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +432 -10
  12. package/generated/ghes-3.3.deref.json +319 -242
  13. package/generated/ghes-3.3.json +558 -26
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +9 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +9 -1
  16. package/generated/ghes-3.4.deref.json +322 -228
  17. package/generated/ghes-3.4.json +566 -28
  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 +45 -39
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.json +283 -15
  22. package/generated/ghes-3.5.deref.json +322 -228
  23. package/generated/ghes-3.5.json +566 -28
  24. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +433 -88
  25. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +17464 -6423
  26. package/generated/ghes-3.6-diff-to-api.github.com.json +4502 -2247
  27. package/generated/ghes-3.6.deref.json +406 -240
  28. package/generated/ghes-3.6.json +654 -40
  29. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +318 -32
  30. package/generated/github.ae-diff-to-api.github.com.deref.json +15845 -8423
  31. package/generated/github.ae-diff-to-api.github.com.json +1168 -44
  32. package/generated/github.ae.deref.json +409 -163
  33. package/generated/github.ae.json +646 -35
  34. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.5.0",
4
+ "version": "7.6.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": {
@@ -2763,14 +2763,6 @@
2763
2763
  "write"
2764
2764
  ]
2765
2765
  },
2766
- "organization_custom_roles": {
2767
- "type": "string",
2768
- "description": "The level of permission to grant the access token for custom roles management.",
2769
- "enum": [
2770
- "read",
2771
- "write"
2772
- ]
2773
- },
2774
2766
  "deployments": {
2775
2767
  "type": "string",
2776
2768
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -3572,14 +3564,6 @@
3572
3564
  "write"
3573
3565
  ]
3574
3566
  },
3575
- "organization_custom_roles": {
3576
- "type": "string",
3577
- "description": "The level of permission to grant the access token for custom roles management.",
3578
- "enum": [
3579
- "read",
3580
- "write"
3581
- ]
3582
- },
3583
3567
  "deployments": {
3584
3568
  "type": "string",
3585
3569
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -4244,14 +4228,6 @@
4244
4228
  "write"
4245
4229
  ]
4246
4230
  },
4247
- "organization_custom_roles": {
4248
- "type": "string",
4249
- "description": "The level of permission to grant the access token for custom roles management.",
4250
- "enum": [
4251
- "read",
4252
- "write"
4253
- ]
4254
- },
4255
4231
  "deployments": {
4256
4232
  "type": "string",
4257
4233
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -6832,14 +6808,6 @@
6832
6808
  "write"
6833
6809
  ]
6834
6810
  },
6835
- "organization_custom_roles": {
6836
- "type": "string",
6837
- "description": "The level of permission to grant the access token for custom roles management.",
6838
- "enum": [
6839
- "read",
6840
- "write"
6841
- ]
6842
- },
6843
6811
  "deployments": {
6844
6812
  "type": "string",
6845
6813
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -7319,7 +7287,13 @@
7319
7287
  "category": "apps",
7320
7288
  "subcategory": null
7321
7289
  },
7322
- "x-octokit": {}
7290
+ "x-octokit": {
7291
+ "diff": {
7292
+ "api.github.com": {
7293
+ "type": "changed"
7294
+ }
7295
+ }
7296
+ }
7323
7297
  }
7324
7298
  },
7325
7299
  "/app/installations/{installation_id}": {
@@ -7629,14 +7603,6 @@
7629
7603
  "write"
7630
7604
  ]
7631
7605
  },
7632
- "organization_custom_roles": {
7633
- "type": "string",
7634
- "description": "The level of permission to grant the access token for custom roles management.",
7635
- "enum": [
7636
- "read",
7637
- "write"
7638
- ]
7639
- },
7640
7606
  "deployments": {
7641
7607
  "type": "string",
7642
7608
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8131,7 +8097,13 @@
8131
8097
  "category": "apps",
8132
8098
  "subcategory": null
8133
8099
  },
8134
- "x-octokit": {}
8100
+ "x-octokit": {
8101
+ "diff": {
8102
+ "api.github.com": {
8103
+ "type": "changed"
8104
+ }
8105
+ }
8106
+ }
8135
8107
  },
8136
8108
  "delete": {
8137
8109
  "summary": "Delete an installation for the authenticated app",
@@ -8290,14 +8262,6 @@
8290
8262
  "write"
8291
8263
  ]
8292
8264
  },
8293
- "organization_custom_roles": {
8294
- "type": "string",
8295
- "description": "The level of permission to grant the access token for custom roles management.",
8296
- "enum": [
8297
- "read",
8298
- "write"
8299
- ]
8300
- },
8301
8265
  "deployments": {
8302
8266
  "type": "string",
8303
8267
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8583,14 +8547,6 @@
8583
8547
  "write"
8584
8548
  ]
8585
8549
  },
8586
- "organization_custom_roles": {
8587
- "type": "string",
8588
- "description": "The level of permission to grant the access token for custom roles management.",
8589
- "enum": [
8590
- "read",
8591
- "write"
8592
- ]
8593
- },
8594
8550
  "deployments": {
8595
8551
  "type": "string",
8596
8552
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -10821,14 +10777,6 @@
10821
10777
  "write"
10822
10778
  ]
10823
10779
  },
10824
- "organization_custom_roles": {
10825
- "type": "string",
10826
- "description": "The level of permission to grant the access token for custom roles management.",
10827
- "enum": [
10828
- "read",
10829
- "write"
10830
- ]
10831
- },
10832
10780
  "deployments": {
10833
10781
  "type": "string",
10834
10782
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -11379,7 +11327,13 @@
11379
11327
  "category": "apps",
11380
11328
  "subcategory": "oauth-applications"
11381
11329
  },
11382
- "x-octokit": {}
11330
+ "x-octokit": {
11331
+ "diff": {
11332
+ "api.github.com": {
11333
+ "type": "changed"
11334
+ }
11335
+ }
11336
+ }
11383
11337
  },
11384
11338
  "patch": {
11385
11339
  "summary": "Reset a token",
@@ -11672,14 +11626,6 @@
11672
11626
  "write"
11673
11627
  ]
11674
11628
  },
11675
- "organization_custom_roles": {
11676
- "type": "string",
11677
- "description": "The level of permission to grant the access token for custom roles management.",
11678
- "enum": [
11679
- "read",
11680
- "write"
11681
- ]
11682
- },
11683
11629
  "deployments": {
11684
11630
  "type": "string",
11685
11631
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -12204,7 +12150,13 @@
12204
12150
  "category": "apps",
12205
12151
  "subcategory": "oauth-applications"
12206
12152
  },
12207
- "x-octokit": {}
12153
+ "x-octokit": {
12154
+ "diff": {
12155
+ "api.github.com": {
12156
+ "type": "changed"
12157
+ }
12158
+ }
12159
+ }
12208
12160
  },
12209
12161
  "delete": {
12210
12162
  "summary": "Delete an app token",
@@ -12616,14 +12568,6 @@
12616
12568
  "write"
12617
12569
  ]
12618
12570
  },
12619
- "organization_custom_roles": {
12620
- "type": "string",
12621
- "description": "The level of permission to grant the access token for custom roles management.",
12622
- "enum": [
12623
- "read",
12624
- "write"
12625
- ]
12626
- },
12627
12571
  "deployments": {
12628
12572
  "type": "string",
12629
12573
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -54299,14 +54243,6 @@
54299
54243
  "write"
54300
54244
  ]
54301
54245
  },
54302
- "organization_custom_roles": {
54303
- "type": "string",
54304
- "description": "The level of permission to grant the access token for custom roles management.",
54305
- "enum": [
54306
- "read",
54307
- "write"
54308
- ]
54309
- },
54310
54246
  "deployments": {
54311
54247
  "type": "string",
54312
54248
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -54775,7 +54711,13 @@
54775
54711
  "category": "apps",
54776
54712
  "subcategory": null
54777
54713
  },
54778
- "x-octokit": {}
54714
+ "x-octokit": {
54715
+ "diff": {
54716
+ "api.github.com": {
54717
+ "type": "changed"
54718
+ }
54719
+ }
54720
+ }
54779
54721
  }
54780
54722
  },
54781
54723
  "/orgs/{org}/installations": {
@@ -55110,14 +55052,6 @@
55110
55052
  "write"
55111
55053
  ]
55112
55054
  },
55113
- "organization_custom_roles": {
55114
- "type": "string",
55115
- "description": "The level of permission to grant the access token for custom roles management.",
55116
- "enum": [
55117
- "read",
55118
- "write"
55119
- ]
55120
- },
55121
55055
  "deployments": {
55122
55056
  "type": "string",
55123
55057
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -55603,7 +55537,13 @@
55603
55537
  "category": "orgs",
55604
55538
  "subcategory": null
55605
55539
  },
55606
- "x-octokit": {}
55540
+ "x-octokit": {
55541
+ "diff": {
55542
+ "api.github.com": {
55543
+ "type": "changed"
55544
+ }
55545
+ }
55546
+ }
55607
55547
  }
55608
55548
  },
55609
55549
  "/orgs/{org}/issues": {
@@ -69905,8 +69845,8 @@
69905
69845
  "example": "2017-08-17T12:37:15Z"
69906
69846
  },
69907
69847
  "organization": {
69908
- "title": "Organization Full",
69909
- "description": "Organization Full",
69848
+ "title": "Team Organization",
69849
+ "description": "Team Organization",
69910
69850
  "type": "object",
69911
69851
  "properties": {
69912
69852
  "login": {
@@ -70546,8 +70486,8 @@
70546
70486
  "example": "2017-08-17T12:37:15Z"
70547
70487
  },
70548
70488
  "organization": {
70549
- "title": "Organization Full",
70550
- "description": "Organization Full",
70489
+ "title": "Team Organization",
70490
+ "description": "Team Organization",
70551
70491
  "type": "object",
70552
70492
  "properties": {
70553
70493
  "login": {
@@ -71168,8 +71108,8 @@
71168
71108
  "example": "2017-08-17T12:37:15Z"
71169
71109
  },
71170
71110
  "organization": {
71171
- "title": "Organization Full",
71172
- "description": "Organization Full",
71111
+ "title": "Team Organization",
71112
+ "description": "Team Organization",
71173
71113
  "type": "object",
71174
71114
  "properties": {
71175
71115
  "login": {
@@ -127522,6 +127462,111 @@
127522
127462
  "protected",
127523
127463
  "protection_url"
127524
127464
  ]
127465
+ },
127466
+ "examples": {
127467
+ "default": {
127468
+ "value": {
127469
+ "name": "main",
127470
+ "commit": {
127471
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
127472
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
127473
+ "commit": {
127474
+ "author": {
127475
+ "name": "The Octocat",
127476
+ "email": "octocat@nowhere.com",
127477
+ "date": "2012-03-06T23:06:50Z"
127478
+ },
127479
+ "committer": {
127480
+ "name": "The Octocat",
127481
+ "email": "octocat@nowhere.com",
127482
+ "date": "2012-03-06T23:06:50Z"
127483
+ },
127484
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
127485
+ "tree": {
127486
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
127487
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
127488
+ },
127489
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
127490
+ "comment_count": 77,
127491
+ "verification": {
127492
+ "verified": false,
127493
+ "reason": "unsigned",
127494
+ "signature": null,
127495
+ "payload": null
127496
+ }
127497
+ },
127498
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
127499
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
127500
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
127501
+ "author": {
127502
+ "login": "octocat",
127503
+ "id": 583231,
127504
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
127505
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
127506
+ "gravatar_id": "",
127507
+ "url": "https://api.github.com/users/octocat",
127508
+ "html_url": "https://github.com/octocat",
127509
+ "followers_url": "https://api.github.com/users/octocat/followers",
127510
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
127511
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
127512
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
127513
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
127514
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
127515
+ "repos_url": "https://api.github.com/users/octocat/repos",
127516
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
127517
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
127518
+ "type": "User",
127519
+ "site_admin": false
127520
+ },
127521
+ "committer": {
127522
+ "login": "octocat",
127523
+ "id": 583231,
127524
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
127525
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
127526
+ "gravatar_id": "",
127527
+ "url": "https://api.github.com/users/octocat",
127528
+ "html_url": "https://github.com/octocat",
127529
+ "followers_url": "https://api.github.com/users/octocat/followers",
127530
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
127531
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
127532
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
127533
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
127534
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
127535
+ "repos_url": "https://api.github.com/users/octocat/repos",
127536
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
127537
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
127538
+ "type": "User",
127539
+ "site_admin": false
127540
+ },
127541
+ "parents": [
127542
+ {
127543
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
127544
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
127545
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
127546
+ },
127547
+ {
127548
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
127549
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
127550
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
127551
+ }
127552
+ ]
127553
+ },
127554
+ "_links": {
127555
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
127556
+ "html": "https://github.com/octocat/Hello-World/tree/main"
127557
+ },
127558
+ "protected": false,
127559
+ "protection": {
127560
+ "enabled": false,
127561
+ "required_status_checks": {
127562
+ "enforcement_level": "off",
127563
+ "contexts": [],
127564
+ "checks": []
127565
+ }
127566
+ },
127567
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
127568
+ }
127569
+ }
127525
127570
  }
127526
127571
  }
127527
127572
  }
@@ -131295,6 +131340,73 @@
131295
131340
  "required": [
131296
131341
  "url"
131297
131342
  ]
131343
+ },
131344
+ "examples": {
131345
+ "default": {
131346
+ "value": {
131347
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
131348
+ "required_status_checks": {
131349
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
131350
+ "strict": true,
131351
+ "contexts": [
131352
+ "continuous-integration/travis-ci"
131353
+ ],
131354
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
131355
+ "checks": [
131356
+ {
131357
+ "context": "continuous-integration/travis-ci",
131358
+ "app_id": null
131359
+ }
131360
+ ]
131361
+ },
131362
+ "restrictions": {
131363
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
131364
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
131365
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
131366
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
131367
+ "users": [],
131368
+ "teams": [],
131369
+ "apps": []
131370
+ },
131371
+ "required_pull_request_reviews": {
131372
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
131373
+ "dismiss_stale_reviews": true,
131374
+ "require_code_owner_reviews": true,
131375
+ "required_approving_review_count": 2,
131376
+ "dismissal_restrictions": {
131377
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
131378
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
131379
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
131380
+ "users": [],
131381
+ "teams": [],
131382
+ "apps": []
131383
+ }
131384
+ },
131385
+ "required_signatures": {
131386
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
131387
+ "enabled": false
131388
+ },
131389
+ "enforce_admins": {
131390
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
131391
+ "enabled": true
131392
+ },
131393
+ "required_linear_history": {
131394
+ "enabled": true
131395
+ },
131396
+ "allow_force_pushes": {
131397
+ "enabled": true
131398
+ },
131399
+ "allow_deletions": {
131400
+ "enabled": true
131401
+ },
131402
+ "block_creations": {
131403
+ "enabled": true
131404
+ },
131405
+ "required_conversation_resolution": {
131406
+ "enabled": true
131407
+ }
131408
+ }
131409
+ }
131298
131410
  }
131299
131411
  }
131300
131412
  }
@@ -135498,7 +135610,7 @@
135498
135610
  "properties": {
135499
135611
  "contexts": {
135500
135612
  "type": "array",
135501
- "description": "contexts parameter",
135613
+ "description": "The name of the status checks",
135502
135614
  "items": {
135503
135615
  "type": "string"
135504
135616
  }
@@ -135514,6 +135626,17 @@
135514
135626
  }
135515
135627
  }
135516
135628
  ]
135629
+ },
135630
+ "examples": {
135631
+ "default": {
135632
+ "summary": "Example adding status checks to a branch protection rule",
135633
+ "value": {
135634
+ "contexts": [
135635
+ "continuous-integration/travis-ci",
135636
+ "continuous-integration/jenkins"
135637
+ ]
135638
+ }
135639
+ }
135517
135640
  }
135518
135641
  }
135519
135642
  }
@@ -135723,7 +135846,7 @@
135723
135846
  "properties": {
135724
135847
  "contexts": {
135725
135848
  "type": "array",
135726
- "description": "contexts parameter",
135849
+ "description": "The name of the status checks",
135727
135850
  "items": {
135728
135851
  "type": "string"
135729
135852
  }
@@ -135739,6 +135862,16 @@
135739
135862
  }
135740
135863
  }
135741
135864
  ]
135865
+ },
135866
+ "examples": {
135867
+ "default": {
135868
+ "summary": "Example updating status checks for a branch protection rule",
135869
+ "value": {
135870
+ "contexts": [
135871
+ "continuous-integration/travis-ci"
135872
+ ]
135873
+ }
135874
+ }
135742
135875
  }
135743
135876
  }
135744
135877
  }
@@ -135920,7 +136053,7 @@
135920
136053
  "properties": {
135921
136054
  "contexts": {
135922
136055
  "type": "array",
135923
- "description": "contexts parameter",
136056
+ "description": "The name of the status checks",
135924
136057
  "items": {
135925
136058
  "type": "string"
135926
136059
  }
@@ -135936,6 +136069,16 @@
135936
136069
  }
135937
136070
  }
135938
136071
  ]
136072
+ },
136073
+ "examples": {
136074
+ "default": {
136075
+ "summary": "Example removing status checks from a branch protection rule",
136076
+ "value": {
136077
+ "contexts": [
136078
+ "continuous-integration/travis-ci"
136079
+ ]
136080
+ }
136081
+ }
135939
136082
  }
135940
136083
  }
135941
136084
  }
@@ -138641,7 +138784,7 @@
138641
138784
  "properties": {
138642
138785
  "teams": {
138643
138786
  "type": "array",
138644
- "description": "teams parameter",
138787
+ "description": "The slug values for teams",
138645
138788
  "items": {
138646
138789
  "type": "string"
138647
138790
  }
@@ -138657,6 +138800,16 @@
138657
138800
  }
138658
138801
  }
138659
138802
  ]
138803
+ },
138804
+ "examples": {
138805
+ "default": {
138806
+ "summary": "Example adding a team in a branch protection rule",
138807
+ "value": {
138808
+ "teams": [
138809
+ "justice-league"
138810
+ ]
138811
+ }
138812
+ }
138660
138813
  }
138661
138814
  }
138662
138815
  }
@@ -138987,7 +139140,7 @@
138987
139140
  "properties": {
138988
139141
  "teams": {
138989
139142
  "type": "array",
138990
- "description": "teams parameter",
139143
+ "description": "The slug values for teams",
138991
139144
  "items": {
138992
139145
  "type": "string"
138993
139146
  }
@@ -138998,11 +139151,21 @@
138998
139151
  ],
138999
139152
  "example": {
139000
139153
  "teams": [
139001
- "my-team"
139154
+ "justice-league"
139002
139155
  ]
139003
139156
  }
139004
139157
  }
139005
139158
  ]
139159
+ },
139160
+ "examples": {
139161
+ "default": {
139162
+ "summary": "Example replacing a team in a branch protection rule",
139163
+ "value": {
139164
+ "teams": [
139165
+ "justice-league"
139166
+ ]
139167
+ }
139168
+ }
139006
139169
  }
139007
139170
  }
139008
139171
  }
@@ -139332,7 +139495,7 @@
139332
139495
  "properties": {
139333
139496
  "teams": {
139334
139497
  "type": "array",
139335
- "description": "teams parameter",
139498
+ "description": "The slug values for teams",
139336
139499
  "items": {
139337
139500
  "type": "string"
139338
139501
  }
@@ -139348,6 +139511,16 @@
139348
139511
  }
139349
139512
  }
139350
139513
  ]
139514
+ },
139515
+ "examples": {
139516
+ "default": {
139517
+ "summary": "Example removing a team in a branch protection rule",
139518
+ "value": {
139519
+ "teams": [
139520
+ "justice-league"
139521
+ ]
139522
+ }
139523
+ }
139351
139524
  }
139352
139525
  }
139353
139526
  }
@@ -139912,7 +140085,7 @@
139912
140085
  "properties": {
139913
140086
  "users": {
139914
140087
  "type": "array",
139915
- "description": "users parameter",
140088
+ "description": "The username for users",
139916
140089
  "items": {
139917
140090
  "type": "string"
139918
140091
  }
@@ -139928,6 +140101,16 @@
139928
140101
  }
139929
140102
  }
139930
140103
  ]
140104
+ },
140105
+ "examples": {
140106
+ "default": {
140107
+ "summary": "Example adding a user in a branch protection rule",
140108
+ "value": {
140109
+ "users": [
140110
+ "octocat"
140111
+ ]
140112
+ }
140113
+ }
139931
140114
  }
139932
140115
  }
139933
140116
  }
@@ -140219,7 +140402,7 @@
140219
140402
  "properties": {
140220
140403
  "users": {
140221
140404
  "type": "array",
140222
- "description": "users parameter",
140405
+ "description": "The username for users",
140223
140406
  "items": {
140224
140407
  "type": "string"
140225
140408
  }
@@ -140235,6 +140418,16 @@
140235
140418
  }
140236
140419
  }
140237
140420
  ]
140421
+ },
140422
+ "examples": {
140423
+ "default": {
140424
+ "summary": "Example replacing a user in a branch protection rule",
140425
+ "value": {
140426
+ "users": [
140427
+ "octocat"
140428
+ ]
140429
+ }
140430
+ }
140238
140431
  }
140239
140432
  }
140240
140433
  }
@@ -140525,7 +140718,7 @@
140525
140718
  "properties": {
140526
140719
  "users": {
140527
140720
  "type": "array",
140528
- "description": "users parameter",
140721
+ "description": "The username for users",
140529
140722
  "items": {
140530
140723
  "type": "string"
140531
140724
  }
@@ -140541,6 +140734,16 @@
140541
140734
  }
140542
140735
  }
140543
140736
  ]
140737
+ },
140738
+ "examples": {
140739
+ "default": {
140740
+ "summary": "Example removing a user in a branch protection rule",
140741
+ "value": {
140742
+ "users": [
140743
+ "octocat"
140744
+ ]
140745
+ }
140746
+ }
140544
140747
  }
140545
140748
  }
140546
140749
  }
@@ -157650,6 +157853,33 @@
157650
157853
  "description": "An identifier for the upload.",
157651
157854
  "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
157652
157855
  }
157856
+ },
157857
+ {
157858
+ "name": "direction",
157859
+ "description": "The direction to sort the results by.",
157860
+ "in": "query",
157861
+ "required": false,
157862
+ "schema": {
157863
+ "type": "string",
157864
+ "enum": [
157865
+ "asc",
157866
+ "desc"
157867
+ ],
157868
+ "default": "desc"
157869
+ }
157870
+ },
157871
+ {
157872
+ "name": "sort",
157873
+ "description": "The property by which to sort the results.",
157874
+ "in": "query",
157875
+ "required": false,
157876
+ "schema": {
157877
+ "type": "string",
157878
+ "enum": [
157879
+ "created"
157880
+ ],
157881
+ "default": "created"
157882
+ }
157653
157883
  }
157654
157884
  ],
157655
157885
  "responses": {
@@ -179274,7 +179504,7 @@
179274
179504
  "/repos/{owner}/{repo}/contents/{path}": {
179275
179505
  "get": {
179276
179506
  "summary": "Get repository content",
179277
- "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/github-ae@latest/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
179507
+ "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/github-ae@latest/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
179278
179508
  "tags": [
179279
179509
  "repos"
179280
179510
  ],
@@ -204640,14 +204870,6 @@
204640
204870
  "write"
204641
204871
  ]
204642
204872
  },
204643
- "organization_custom_roles": {
204644
- "type": "string",
204645
- "description": "The level of permission to grant the access token for custom roles management.",
204646
- "enum": [
204647
- "read",
204648
- "write"
204649
- ]
204650
- },
204651
204873
  "deployments": {
204652
204874
  "type": "string",
204653
204875
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -205168,7 +205390,13 @@
205168
205390
  "category": "apps",
205169
205391
  "subcategory": null
205170
205392
  },
205171
- "x-octokit": {}
205393
+ "x-octokit": {
205394
+ "diff": {
205395
+ "api.github.com": {
205396
+ "type": "changed"
205397
+ }
205398
+ }
205399
+ }
205172
205400
  }
205173
205401
  },
205174
205402
  "/repos/{owner}/{repo}/invitations": {
@@ -207421,6 +207649,14 @@
207421
207649
  ]
207422
207650
  }
207423
207651
  }
207652
+ },
207653
+ "examples": {
207654
+ "default": {
207655
+ "summary": "Example request body",
207656
+ "value": {
207657
+ "permissions": "write"
207658
+ }
207659
+ }
207424
207660
  }
207425
207661
  }
207426
207662
  }
@@ -212257,7 +212493,8 @@
212257
212493
  "type": "User",
212258
212494
  "site_admin": false
212259
212495
  },
212260
- "author_association": "COLLABORATOR"
212496
+ "author_association": "COLLABORATOR",
212497
+ "state_reason": "completed"
212261
212498
  }
212262
212499
  ]
212263
212500
  }
@@ -215037,7 +215274,8 @@
215037
215274
  "type": "User",
215038
215275
  "site_admin": false
215039
215276
  },
215040
- "author_association": "COLLABORATOR"
215277
+ "author_association": "COLLABORATOR",
215278
+ "state_reason": "completed"
215041
215279
  }
215042
215280
  }
215043
215281
  }
@@ -222028,7 +222266,8 @@
222028
222266
  "closed_at": null,
222029
222267
  "created_at": "2011-04-22T13:33:48Z",
222030
222268
  "updated_at": "2011-04-22T13:33:48Z",
222031
- "author_association": "COLLABORATOR"
222269
+ "author_association": "COLLABORATOR",
222270
+ "state_reason": "completed"
222032
222271
  }
222033
222272
  }
222034
222273
  ]
@@ -225904,7 +226143,8 @@
225904
226143
  "closed_at": null,
225905
226144
  "created_at": "2011-04-22T13:33:48Z",
225906
226145
  "updated_at": "2011-04-22T13:33:48Z",
225907
- "author_association": "COLLABORATOR"
226146
+ "author_association": "COLLABORATOR",
226147
+ "state_reason": "completed"
225908
226148
  }
225909
226149
  }
225910
226150
  }
@@ -228545,7 +228785,8 @@
228545
228785
  "type": "User",
228546
228786
  "site_admin": false
228547
228787
  },
228548
- "author_association": "COLLABORATOR"
228788
+ "author_association": "COLLABORATOR",
228789
+ "state_reason": "completed"
228549
228790
  }
228550
228791
  }
228551
228792
  }
@@ -228725,6 +228966,12 @@
228725
228966
  "closed"
228726
228967
  ]
228727
228968
  },
228969
+ "state_reason": {
228970
+ "type": "string",
228971
+ "nullable": true,
228972
+ "description": "The reason for the current state",
228973
+ "example": "not_planned"
228974
+ },
228728
228975
  "milestone": {
228729
228976
  "oneOf": [
228730
228977
  {
@@ -231293,7 +231540,8 @@
231293
231540
  "type": "User",
231294
231541
  "site_admin": false
231295
231542
  },
231296
- "author_association": "COLLABORATOR"
231543
+ "author_association": "COLLABORATOR",
231544
+ "state_reason": "completed"
231297
231545
  }
231298
231546
  }
231299
231547
  }
@@ -234078,7 +234326,8 @@
234078
234326
  "type": "User",
234079
234327
  "site_admin": false
234080
234328
  },
234081
- "author_association": "COLLABORATOR"
234329
+ "author_association": "COLLABORATOR",
234330
+ "state_reason": "completed"
234082
234331
  }
234083
234332
  }
234084
234333
  }
@@ -325591,7 +325840,8 @@
325591
325840
  "body": "...",
325592
325841
  "score": 1,
325593
325842
  "locked": true,
325594
- "author_association": "COLLABORATOR"
325843
+ "author_association": "COLLABORATOR",
325844
+ "state_reason": "completed"
325595
325845
  }
325596
325846
  ]
325597
325847
  }
@@ -327925,8 +328175,8 @@
327925
328175
  "example": "2017-08-17T12:37:15Z"
327926
328176
  },
327927
328177
  "organization": {
327928
- "title": "Organization Full",
327929
- "description": "Organization Full",
328178
+ "title": "Team Organization",
328179
+ "description": "Team Organization",
327930
328180
  "type": "object",
327931
328181
  "properties": {
327932
328182
  "login": {
@@ -328544,8 +328794,8 @@
328544
328794
  "example": "2017-08-17T12:37:15Z"
328545
328795
  },
328546
328796
  "organization": {
328547
- "title": "Organization Full",
328548
- "description": "Organization Full",
328797
+ "title": "Team Organization",
328798
+ "description": "Team Organization",
328549
328799
  "type": "object",
328550
328800
  "properties": {
328551
328801
  "login": {
@@ -329047,8 +329297,8 @@
329047
329297
  "example": "2017-08-17T12:37:15Z"
329048
329298
  },
329049
329299
  "organization": {
329050
- "title": "Organization Full",
329051
- "description": "Organization Full",
329300
+ "title": "Team Organization",
329301
+ "description": "Team Organization",
329052
329302
  "type": "object",
329053
329303
  "properties": {
329054
329304
  "login": {
@@ -342882,14 +343132,6 @@
342882
343132
  "write"
342883
343133
  ]
342884
343134
  },
342885
- "organization_custom_roles": {
342886
- "type": "string",
342887
- "description": "The level of permission to grant the access token for custom roles management.",
342888
- "enum": [
342889
- "read",
342890
- "write"
342891
- ]
342892
- },
342893
343135
  "deployments": {
342894
343136
  "type": "string",
342895
343137
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -343479,7 +343721,13 @@
343479
343721
  "category": "apps",
343480
343722
  "subcategory": "installations"
343481
343723
  },
343482
- "x-octokit": {}
343724
+ "x-octokit": {
343725
+ "diff": {
343726
+ "api.github.com": {
343727
+ "type": "changed"
343728
+ }
343729
+ }
343730
+ }
343483
343731
  }
343484
343732
  },
343485
343733
  "/user/installations/{installation_id}/repositories": {
@@ -366841,8 +367089,8 @@
366841
367089
  "example": "2017-08-17T12:37:15Z"
366842
367090
  },
366843
367091
  "organization": {
366844
- "title": "Organization Full",
366845
- "description": "Organization Full",
367092
+ "title": "Team Organization",
367093
+ "description": "Team Organization",
366846
367094
  "type": "object",
366847
367095
  "properties": {
366848
367096
  "login": {
@@ -376133,14 +376381,6 @@
376133
376381
  "write"
376134
376382
  ]
376135
376383
  },
376136
- "organization_custom_roles": {
376137
- "type": "string",
376138
- "description": "The level of permission to grant the access token for custom roles management.",
376139
- "enum": [
376140
- "read",
376141
- "write"
376142
- ]
376143
- },
376144
376384
  "deployments": {
376145
376385
  "type": "string",
376146
376386
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -376609,7 +376849,13 @@
376609
376849
  "category": "apps",
376610
376850
  "subcategory": null
376611
376851
  },
376612
- "x-octokit": {}
376852
+ "x-octokit": {
376853
+ "diff": {
376854
+ "api.github.com": {
376855
+ "type": "changed"
376856
+ }
376857
+ }
376858
+ }
376613
376859
  }
376614
376860
  },
376615
376861
  "/users/{username}/keys": {