@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": {
@@ -4087,14 +4087,6 @@
4087
4087
  "write"
4088
4088
  ]
4089
4089
  },
4090
- "organization_custom_roles": {
4091
- "type": "string",
4092
- "description": "The level of permission to grant the access token for custom roles management.",
4093
- "enum": [
4094
- "read",
4095
- "write"
4096
- ]
4097
- },
4098
4090
  "deployments": {
4099
4091
  "type": "string",
4100
4092
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -5191,14 +5183,6 @@
5191
5183
  "write"
5192
5184
  ]
5193
5185
  },
5194
- "organization_custom_roles": {
5195
- "type": "string",
5196
- "description": "The level of permission to grant the access token for custom roles management.",
5197
- "enum": [
5198
- "read",
5199
- "write"
5200
- ]
5201
- },
5202
5186
  "deployments": {
5203
5187
  "type": "string",
5204
5188
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -5871,14 +5855,6 @@
5871
5855
  "write"
5872
5856
  ]
5873
5857
  },
5874
- "organization_custom_roles": {
5875
- "type": "string",
5876
- "description": "The level of permission to grant the access token for custom roles management.",
5877
- "enum": [
5878
- "read",
5879
- "write"
5880
- ]
5881
- },
5882
5858
  "deployments": {
5883
5859
  "type": "string",
5884
5860
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8462,14 +8438,6 @@
8462
8438
  "write"
8463
8439
  ]
8464
8440
  },
8465
- "organization_custom_roles": {
8466
- "type": "string",
8467
- "description": "The level of permission to grant the access token for custom roles management.",
8468
- "enum": [
8469
- "read",
8470
- "write"
8471
- ]
8472
- },
8473
8441
  "deployments": {
8474
8442
  "type": "string",
8475
8443
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -9273,14 +9241,6 @@
9273
9241
  "write"
9274
9242
  ]
9275
9243
  },
9276
- "organization_custom_roles": {
9277
- "type": "string",
9278
- "description": "The level of permission to grant the access token for custom roles management.",
9279
- "enum": [
9280
- "read",
9281
- "write"
9282
- ]
9283
- },
9284
9244
  "deployments": {
9285
9245
  "type": "string",
9286
9246
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -9948,14 +9908,6 @@
9948
9908
  "write"
9949
9909
  ]
9950
9910
  },
9951
- "organization_custom_roles": {
9952
- "type": "string",
9953
- "description": "The level of permission to grant the access token for custom roles management.",
9954
- "enum": [
9955
- "read",
9956
- "write"
9957
- ]
9958
- },
9959
9911
  "deployments": {
9960
9912
  "type": "string",
9961
9913
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -10249,14 +10201,6 @@
10249
10201
  "write"
10250
10202
  ]
10251
10203
  },
10252
- "organization_custom_roles": {
10253
- "type": "string",
10254
- "description": "The level of permission to grant the access token for custom roles management.",
10255
- "enum": [
10256
- "read",
10257
- "write"
10258
- ]
10259
- },
10260
10204
  "deployments": {
10261
10205
  "type": "string",
10262
10206
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -13299,14 +13243,6 @@
13299
13243
  "write"
13300
13244
  ]
13301
13245
  },
13302
- "organization_custom_roles": {
13303
- "type": "string",
13304
- "description": "The level of permission to grant the access token for custom roles management.",
13305
- "enum": [
13306
- "read",
13307
- "write"
13308
- ]
13309
- },
13310
13246
  "deployments": {
13311
13247
  "type": "string",
13312
13248
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -14164,14 +14100,6 @@
14164
14100
  "write"
14165
14101
  ]
14166
14102
  },
14167
- "organization_custom_roles": {
14168
- "type": "string",
14169
- "description": "The level of permission to grant the access token for custom roles management.",
14170
- "enum": [
14171
- "read",
14172
- "write"
14173
- ]
14174
- },
14175
14103
  "deployments": {
14176
14104
  "type": "string",
14177
14105
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -14953,14 +14881,6 @@
14953
14881
  "write"
14954
14882
  ]
14955
14883
  },
14956
- "organization_custom_roles": {
14957
- "type": "string",
14958
- "description": "The level of permission to grant the access token for custom roles management.",
14959
- "enum": [
14960
- "read",
14961
- "write"
14962
- ]
14963
- },
14964
14884
  "deployments": {
14965
14885
  "type": "string",
14966
14886
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -15444,14 +15364,6 @@
15444
15364
  "write"
15445
15365
  ]
15446
15366
  },
15447
- "organization_custom_roles": {
15448
- "type": "string",
15449
- "description": "The level of permission to grant the access token for custom roles management.",
15450
- "enum": [
15451
- "read",
15452
- "write"
15453
- ]
15454
- },
15455
15367
  "deployments": {
15456
15368
  "type": "string",
15457
15369
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -16374,14 +16286,6 @@
16374
16286
  "write"
16375
16287
  ]
16376
16288
  },
16377
- "organization_custom_roles": {
16378
- "type": "string",
16379
- "description": "The level of permission to grant the access token for custom roles management.",
16380
- "enum": [
16381
- "read",
16382
- "write"
16383
- ]
16384
- },
16385
16289
  "deployments": {
16386
16290
  "type": "string",
16387
16291
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -17156,14 +17060,6 @@
17156
17060
  "write"
17157
17061
  ]
17158
17062
  },
17159
- "organization_custom_roles": {
17160
- "type": "string",
17161
- "description": "The level of permission to grant the access token for custom roles management.",
17162
- "enum": [
17163
- "read",
17164
- "write"
17165
- ]
17166
- },
17167
17063
  "deployments": {
17168
17064
  "type": "string",
17169
17065
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -18359,14 +18255,6 @@
18359
18255
  "write"
18360
18256
  ]
18361
18257
  },
18362
- "organization_custom_roles": {
18363
- "type": "string",
18364
- "description": "The level of permission to grant the access token for custom roles management.",
18365
- "enum": [
18366
- "read",
18367
- "write"
18368
- ]
18369
- },
18370
18258
  "deployments": {
18371
18259
  "type": "string",
18372
18260
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -19234,14 +19122,6 @@
19234
19122
  "write"
19235
19123
  ]
19236
19124
  },
19237
- "organization_custom_roles": {
19238
- "type": "string",
19239
- "description": "The level of permission to grant the access token for custom roles management.",
19240
- "enum": [
19241
- "read",
19242
- "write"
19243
- ]
19244
- },
19245
19125
  "deployments": {
19246
19126
  "type": "string",
19247
19127
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -20178,14 +20058,6 @@
20178
20058
  "write"
20179
20059
  ]
20180
20060
  },
20181
- "organization_custom_roles": {
20182
- "type": "string",
20183
- "description": "The level of permission to grant the access token for custom roles management.",
20184
- "enum": [
20185
- "read",
20186
- "write"
20187
- ]
20188
- },
20189
20061
  "deployments": {
20190
20062
  "type": "string",
20191
20063
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -20866,14 +20738,6 @@
20866
20738
  "write"
20867
20739
  ]
20868
20740
  },
20869
- "organization_custom_roles": {
20870
- "type": "string",
20871
- "description": "The level of permission to grant the access token for custom roles management.",
20872
- "enum": [
20873
- "read",
20874
- "write"
20875
- ]
20876
- },
20877
20741
  "deployments": {
20878
20742
  "type": "string",
20879
20743
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -21788,14 +21652,6 @@
21788
21652
  "write"
21789
21653
  ]
21790
21654
  },
21791
- "organization_custom_roles": {
21792
- "type": "string",
21793
- "description": "The level of permission to grant the access token for custom roles management.",
21794
- "enum": [
21795
- "read",
21796
- "write"
21797
- ]
21798
- },
21799
21655
  "deployments": {
21800
21656
  "type": "string",
21801
21657
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -22476,14 +22332,6 @@
22476
22332
  "write"
22477
22333
  ]
22478
22334
  },
22479
- "organization_custom_roles": {
22480
- "type": "string",
22481
- "description": "The level of permission to grant the access token for custom roles management.",
22482
- "enum": [
22483
- "read",
22484
- "write"
22485
- ]
22486
- },
22487
22335
  "deployments": {
22488
22336
  "type": "string",
22489
22337
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -23276,14 +23124,6 @@
23276
23124
  "write"
23277
23125
  ]
23278
23126
  },
23279
- "organization_custom_roles": {
23280
- "type": "string",
23281
- "description": "The level of permission to grant the access token for custom roles management.",
23282
- "enum": [
23283
- "read",
23284
- "write"
23285
- ]
23286
- },
23287
23127
  "deployments": {
23288
23128
  "type": "string",
23289
23129
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -24103,14 +23943,6 @@
24103
23943
  "write"
24104
23944
  ]
24105
23945
  },
24106
- "organization_custom_roles": {
24107
- "type": "string",
24108
- "description": "The level of permission to grant the access token for custom roles management.",
24109
- "enum": [
24110
- "read",
24111
- "write"
24112
- ]
24113
- },
24114
23946
  "deployments": {
24115
23947
  "type": "string",
24116
23948
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -77180,14 +77012,6 @@
77180
77012
  "write"
77181
77013
  ]
77182
77014
  },
77183
- "organization_custom_roles": {
77184
- "type": "string",
77185
- "description": "The level of permission to grant the access token for custom roles management.",
77186
- "enum": [
77187
- "read",
77188
- "write"
77189
- ]
77190
- },
77191
77015
  "deployments": {
77192
77016
  "type": "string",
77193
77017
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -78005,14 +77829,6 @@
78005
77829
  "write"
78006
77830
  ]
78007
77831
  },
78008
- "organization_custom_roles": {
78009
- "type": "string",
78010
- "description": "The level of permission to grant the access token for custom roles management.",
78011
- "enum": [
78012
- "read",
78013
- "write"
78014
- ]
78015
- },
78016
77832
  "deployments": {
78017
77833
  "type": "string",
78018
77834
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -89625,8 +89441,8 @@
89625
89441
  "example": "2017-08-17T12:37:15Z"
89626
89442
  },
89627
89443
  "organization": {
89628
- "title": "Organization Full",
89629
- "description": "Organization Full",
89444
+ "title": "Team Organization",
89445
+ "description": "Team Organization",
89630
89446
  "type": "object",
89631
89447
  "properties": {
89632
89448
  "login": {
@@ -90262,8 +90078,8 @@
90262
90078
  "example": "2017-08-17T12:37:15Z"
90263
90079
  },
90264
90080
  "organization": {
90265
- "title": "Organization Full",
90266
- "description": "Organization Full",
90081
+ "title": "Team Organization",
90082
+ "description": "Team Organization",
90267
90083
  "type": "object",
90268
90084
  "properties": {
90269
90085
  "login": {
@@ -90880,8 +90696,8 @@
90880
90696
  "example": "2017-08-17T12:37:15Z"
90881
90697
  },
90882
90698
  "organization": {
90883
- "title": "Organization Full",
90884
- "description": "Organization Full",
90699
+ "title": "Team Organization",
90700
+ "description": "Team Organization",
90885
90701
  "type": "object",
90886
90702
  "properties": {
90887
90703
  "login": {
@@ -140913,6 +140729,111 @@
140913
140729
  "protected",
140914
140730
  "protection_url"
140915
140731
  ]
140732
+ },
140733
+ "examples": {
140734
+ "default": {
140735
+ "value": {
140736
+ "name": "main",
140737
+ "commit": {
140738
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
140739
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
140740
+ "commit": {
140741
+ "author": {
140742
+ "name": "The Octocat",
140743
+ "email": "octocat@nowhere.com",
140744
+ "date": "2012-03-06T23:06:50Z"
140745
+ },
140746
+ "committer": {
140747
+ "name": "The Octocat",
140748
+ "email": "octocat@nowhere.com",
140749
+ "date": "2012-03-06T23:06:50Z"
140750
+ },
140751
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
140752
+ "tree": {
140753
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
140754
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
140755
+ },
140756
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
140757
+ "comment_count": 77,
140758
+ "verification": {
140759
+ "verified": false,
140760
+ "reason": "unsigned",
140761
+ "signature": null,
140762
+ "payload": null
140763
+ }
140764
+ },
140765
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
140766
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
140767
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
140768
+ "author": {
140769
+ "login": "octocat",
140770
+ "id": 583231,
140771
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
140772
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
140773
+ "gravatar_id": "",
140774
+ "url": "https://api.github.com/users/octocat",
140775
+ "html_url": "https://github.com/octocat",
140776
+ "followers_url": "https://api.github.com/users/octocat/followers",
140777
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
140778
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
140779
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
140780
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
140781
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
140782
+ "repos_url": "https://api.github.com/users/octocat/repos",
140783
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
140784
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
140785
+ "type": "User",
140786
+ "site_admin": false
140787
+ },
140788
+ "committer": {
140789
+ "login": "octocat",
140790
+ "id": 583231,
140791
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
140792
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
140793
+ "gravatar_id": "",
140794
+ "url": "https://api.github.com/users/octocat",
140795
+ "html_url": "https://github.com/octocat",
140796
+ "followers_url": "https://api.github.com/users/octocat/followers",
140797
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
140798
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
140799
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
140800
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
140801
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
140802
+ "repos_url": "https://api.github.com/users/octocat/repos",
140803
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
140804
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
140805
+ "type": "User",
140806
+ "site_admin": false
140807
+ },
140808
+ "parents": [
140809
+ {
140810
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
140811
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
140812
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
140813
+ },
140814
+ {
140815
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
140816
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
140817
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
140818
+ }
140819
+ ]
140820
+ },
140821
+ "_links": {
140822
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
140823
+ "html": "https://github.com/octocat/Hello-World/tree/main"
140824
+ },
140825
+ "protected": false,
140826
+ "protection": {
140827
+ "enabled": false,
140828
+ "required_status_checks": {
140829
+ "enforcement_level": "off",
140830
+ "contexts": [],
140831
+ "checks": []
140832
+ }
140833
+ },
140834
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
140835
+ }
140836
+ }
140916
140837
  }
140917
140838
  }
140918
140839
  }
@@ -143545,6 +143466,73 @@
143545
143466
  "required": [
143546
143467
  "url"
143547
143468
  ]
143469
+ },
143470
+ "examples": {
143471
+ "default": {
143472
+ "value": {
143473
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
143474
+ "required_status_checks": {
143475
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
143476
+ "strict": true,
143477
+ "contexts": [
143478
+ "continuous-integration/travis-ci"
143479
+ ],
143480
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
143481
+ "checks": [
143482
+ {
143483
+ "context": "continuous-integration/travis-ci",
143484
+ "app_id": null
143485
+ }
143486
+ ]
143487
+ },
143488
+ "restrictions": {
143489
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
143490
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
143491
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
143492
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
143493
+ "users": [],
143494
+ "teams": [],
143495
+ "apps": []
143496
+ },
143497
+ "required_pull_request_reviews": {
143498
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
143499
+ "dismiss_stale_reviews": true,
143500
+ "require_code_owner_reviews": true,
143501
+ "required_approving_review_count": 2,
143502
+ "dismissal_restrictions": {
143503
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
143504
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
143505
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
143506
+ "users": [],
143507
+ "teams": [],
143508
+ "apps": []
143509
+ }
143510
+ },
143511
+ "required_signatures": {
143512
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
143513
+ "enabled": false
143514
+ },
143515
+ "enforce_admins": {
143516
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
143517
+ "enabled": true
143518
+ },
143519
+ "required_linear_history": {
143520
+ "enabled": true
143521
+ },
143522
+ "allow_force_pushes": {
143523
+ "enabled": true
143524
+ },
143525
+ "allow_deletions": {
143526
+ "enabled": true
143527
+ },
143528
+ "block_creations": {
143529
+ "enabled": true
143530
+ },
143531
+ "required_conversation_resolution": {
143532
+ "enabled": true
143533
+ }
143534
+ }
143535
+ }
143548
143536
  }
143549
143537
  }
143550
143538
  }
@@ -146596,7 +146584,7 @@
146596
146584
  "properties": {
146597
146585
  "contexts": {
146598
146586
  "type": "array",
146599
- "description": "contexts parameter",
146587
+ "description": "The name of the status checks",
146600
146588
  "items": {
146601
146589
  "type": "string"
146602
146590
  }
@@ -146612,6 +146600,17 @@
146612
146600
  }
146613
146601
  }
146614
146602
  ]
146603
+ },
146604
+ "examples": {
146605
+ "default": {
146606
+ "summary": "Example adding status checks to a branch protection rule",
146607
+ "value": {
146608
+ "contexts": [
146609
+ "continuous-integration/travis-ci",
146610
+ "continuous-integration/jenkins"
146611
+ ]
146612
+ }
146613
+ }
146615
146614
  }
146616
146615
  }
146617
146616
  }
@@ -146821,7 +146820,7 @@
146821
146820
  "properties": {
146822
146821
  "contexts": {
146823
146822
  "type": "array",
146824
- "description": "contexts parameter",
146823
+ "description": "The name of the status checks",
146825
146824
  "items": {
146826
146825
  "type": "string"
146827
146826
  }
@@ -146837,6 +146836,16 @@
146837
146836
  }
146838
146837
  }
146839
146838
  ]
146839
+ },
146840
+ "examples": {
146841
+ "default": {
146842
+ "summary": "Example updating status checks for a branch protection rule",
146843
+ "value": {
146844
+ "contexts": [
146845
+ "continuous-integration/travis-ci"
146846
+ ]
146847
+ }
146848
+ }
146840
146849
  }
146841
146850
  }
146842
146851
  }
@@ -147018,7 +147027,7 @@
147018
147027
  "properties": {
147019
147028
  "contexts": {
147020
147029
  "type": "array",
147021
- "description": "contexts parameter",
147030
+ "description": "The name of the status checks",
147022
147031
  "items": {
147023
147032
  "type": "string"
147024
147033
  }
@@ -147034,6 +147043,16 @@
147034
147043
  }
147035
147044
  }
147036
147045
  ]
147046
+ },
147047
+ "examples": {
147048
+ "default": {
147049
+ "summary": "Example removing status checks from a branch protection rule",
147050
+ "value": {
147051
+ "contexts": [
147052
+ "continuous-integration/travis-ci"
147053
+ ]
147054
+ }
147055
+ }
147037
147056
  }
147038
147057
  }
147039
147058
  }
@@ -149739,7 +149758,7 @@
149739
149758
  "properties": {
149740
149759
  "teams": {
149741
149760
  "type": "array",
149742
- "description": "teams parameter",
149761
+ "description": "The slug values for teams",
149743
149762
  "items": {
149744
149763
  "type": "string"
149745
149764
  }
@@ -149755,6 +149774,16 @@
149755
149774
  }
149756
149775
  }
149757
149776
  ]
149777
+ },
149778
+ "examples": {
149779
+ "default": {
149780
+ "summary": "Example adding a team in a branch protection rule",
149781
+ "value": {
149782
+ "teams": [
149783
+ "justice-league"
149784
+ ]
149785
+ }
149786
+ }
149758
149787
  }
149759
149788
  }
149760
149789
  }
@@ -150085,7 +150114,7 @@
150085
150114
  "properties": {
150086
150115
  "teams": {
150087
150116
  "type": "array",
150088
- "description": "teams parameter",
150117
+ "description": "The slug values for teams",
150089
150118
  "items": {
150090
150119
  "type": "string"
150091
150120
  }
@@ -150096,11 +150125,21 @@
150096
150125
  ],
150097
150126
  "example": {
150098
150127
  "teams": [
150099
- "my-team"
150128
+ "justice-league"
150100
150129
  ]
150101
150130
  }
150102
150131
  }
150103
150132
  ]
150133
+ },
150134
+ "examples": {
150135
+ "default": {
150136
+ "summary": "Example replacing a team in a branch protection rule",
150137
+ "value": {
150138
+ "teams": [
150139
+ "justice-league"
150140
+ ]
150141
+ }
150142
+ }
150104
150143
  }
150105
150144
  }
150106
150145
  }
@@ -150430,7 +150469,7 @@
150430
150469
  "properties": {
150431
150470
  "teams": {
150432
150471
  "type": "array",
150433
- "description": "teams parameter",
150472
+ "description": "The slug values for teams",
150434
150473
  "items": {
150435
150474
  "type": "string"
150436
150475
  }
@@ -150446,6 +150485,16 @@
150446
150485
  }
150447
150486
  }
150448
150487
  ]
150488
+ },
150489
+ "examples": {
150490
+ "default": {
150491
+ "summary": "Example removing a team in a branch protection rule",
150492
+ "value": {
150493
+ "teams": [
150494
+ "justice-league"
150495
+ ]
150496
+ }
150497
+ }
150449
150498
  }
150450
150499
  }
150451
150500
  }
@@ -151010,7 +151059,7 @@
151010
151059
  "properties": {
151011
151060
  "users": {
151012
151061
  "type": "array",
151013
- "description": "users parameter",
151062
+ "description": "The username for users",
151014
151063
  "items": {
151015
151064
  "type": "string"
151016
151065
  }
@@ -151026,6 +151075,16 @@
151026
151075
  }
151027
151076
  }
151028
151077
  ]
151078
+ },
151079
+ "examples": {
151080
+ "default": {
151081
+ "summary": "Example adding a user in a branch protection rule",
151082
+ "value": {
151083
+ "users": [
151084
+ "octocat"
151085
+ ]
151086
+ }
151087
+ }
151029
151088
  }
151030
151089
  }
151031
151090
  }
@@ -151317,7 +151376,7 @@
151317
151376
  "properties": {
151318
151377
  "users": {
151319
151378
  "type": "array",
151320
- "description": "users parameter",
151379
+ "description": "The username for users",
151321
151380
  "items": {
151322
151381
  "type": "string"
151323
151382
  }
@@ -151333,6 +151392,16 @@
151333
151392
  }
151334
151393
  }
151335
151394
  ]
151395
+ },
151396
+ "examples": {
151397
+ "default": {
151398
+ "summary": "Example replacing a user in a branch protection rule",
151399
+ "value": {
151400
+ "users": [
151401
+ "octocat"
151402
+ ]
151403
+ }
151404
+ }
151336
151405
  }
151337
151406
  }
151338
151407
  }
@@ -151623,7 +151692,7 @@
151623
151692
  "properties": {
151624
151693
  "users": {
151625
151694
  "type": "array",
151626
- "description": "users parameter",
151695
+ "description": "The username for users",
151627
151696
  "items": {
151628
151697
  "type": "string"
151629
151698
  }
@@ -151639,6 +151708,16 @@
151639
151708
  }
151640
151709
  }
151641
151710
  ]
151711
+ },
151712
+ "examples": {
151713
+ "default": {
151714
+ "summary": "Example removing a user in a branch protection rule",
151715
+ "value": {
151716
+ "users": [
151717
+ "octocat"
151718
+ ]
151719
+ }
151720
+ }
151642
151721
  }
151643
151722
  }
151644
151723
  }
@@ -192192,7 +192271,7 @@
192192
192271
  "/repos/{owner}/{repo}/contents/{path}": {
192193
192272
  "get": {
192194
192273
  "summary": "Get repository content",
192195
- "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/enterprise-server@3.3/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/enterprise-server@3.3/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/enterprise-server@3.3/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/enterprise-server@3.3/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.",
192274
+ "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/enterprise-server@3.3/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/enterprise-server@3.3/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/enterprise-server@3.3/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/enterprise-server@3.3/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.",
192196
192275
  "tags": [
192197
192276
  "repos"
192198
192277
  ],
@@ -217498,14 +217577,6 @@
217498
217577
  "write"
217499
217578
  ]
217500
217579
  },
217501
- "organization_custom_roles": {
217502
- "type": "string",
217503
- "description": "The level of permission to grant the access token for custom roles management.",
217504
- "enum": [
217505
- "read",
217506
- "write"
217507
- ]
217508
- },
217509
217580
  "deployments": {
217510
217581
  "type": "string",
217511
217582
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -220274,6 +220345,14 @@
220274
220345
  ]
220275
220346
  }
220276
220347
  }
220348
+ },
220349
+ "examples": {
220350
+ "default": {
220351
+ "summary": "Example request body",
220352
+ "value": {
220353
+ "permissions": "write"
220354
+ }
220355
+ }
220277
220356
  }
220278
220357
  }
220279
220358
  }
@@ -225086,7 +225165,8 @@
225086
225165
  "type": "User",
225087
225166
  "site_admin": false
225088
225167
  },
225089
- "author_association": "COLLABORATOR"
225168
+ "author_association": "COLLABORATOR",
225169
+ "state_reason": "completed"
225090
225170
  }
225091
225171
  ]
225092
225172
  }
@@ -227855,7 +227935,8 @@
227855
227935
  "type": "User",
227856
227936
  "site_admin": false
227857
227937
  },
227858
- "author_association": "COLLABORATOR"
227938
+ "author_association": "COLLABORATOR",
227939
+ "state_reason": "completed"
227859
227940
  }
227860
227941
  }
227861
227942
  }
@@ -234820,7 +234901,8 @@
234820
234901
  "closed_at": null,
234821
234902
  "created_at": "2011-04-22T13:33:48Z",
234822
234903
  "updated_at": "2011-04-22T13:33:48Z",
234823
- "author_association": "COLLABORATOR"
234904
+ "author_association": "COLLABORATOR",
234905
+ "state_reason": "completed"
234824
234906
  }
234825
234907
  }
234826
234908
  ]
@@ -238685,7 +238767,8 @@
238685
238767
  "closed_at": null,
238686
238768
  "created_at": "2011-04-22T13:33:48Z",
238687
238769
  "updated_at": "2011-04-22T13:33:48Z",
238688
- "author_association": "COLLABORATOR"
238770
+ "author_association": "COLLABORATOR",
238771
+ "state_reason": "completed"
238689
238772
  }
238690
238773
  }
238691
238774
  }
@@ -241315,7 +241398,8 @@
241315
241398
  "type": "User",
241316
241399
  "site_admin": false
241317
241400
  },
241318
- "author_association": "COLLABORATOR"
241401
+ "author_association": "COLLABORATOR",
241402
+ "state_reason": "completed"
241319
241403
  }
241320
241404
  }
241321
241405
  }
@@ -241489,6 +241573,12 @@
241489
241573
  "closed"
241490
241574
  ]
241491
241575
  },
241576
+ "state_reason": {
241577
+ "type": "string",
241578
+ "nullable": true,
241579
+ "description": "The reason for the current state",
241580
+ "example": "not_planned"
241581
+ },
241492
241582
  "milestone": {
241493
241583
  "oneOf": [
241494
241584
  {
@@ -244052,7 +244142,8 @@
244052
244142
  "type": "User",
244053
244143
  "site_admin": false
244054
244144
  },
244055
- "author_association": "COLLABORATOR"
244145
+ "author_association": "COLLABORATOR",
244146
+ "state_reason": "completed"
244056
244147
  }
244057
244148
  }
244058
244149
  }
@@ -246826,7 +246917,8 @@
246826
246917
  "type": "User",
246827
246918
  "site_admin": false
246828
246919
  },
246829
- "author_association": "COLLABORATOR"
246920
+ "author_association": "COLLABORATOR",
246921
+ "state_reason": "completed"
246830
246922
  }
246831
246923
  }
246832
246924
  }
@@ -340193,7 +340285,8 @@
340193
340285
  "body": "...",
340194
340286
  "score": 1,
340195
340287
  "locked": true,
340196
- "author_association": "COLLABORATOR"
340288
+ "author_association": "COLLABORATOR",
340289
+ "state_reason": "completed"
340197
340290
  }
340198
340291
  ]
340199
340292
  }
@@ -343968,8 +344061,8 @@
343968
344061
  "example": "2017-08-17T12:37:15Z"
343969
344062
  },
343970
344063
  "organization": {
343971
- "title": "Organization Full",
343972
- "description": "Organization Full",
344064
+ "title": "Team Organization",
344065
+ "description": "Team Organization",
343973
344066
  "type": "object",
343974
344067
  "properties": {
343975
344068
  "login": {
@@ -344583,8 +344676,8 @@
344583
344676
  "example": "2017-08-17T12:37:15Z"
344584
344677
  },
344585
344678
  "organization": {
344586
- "title": "Organization Full",
344587
- "description": "Organization Full",
344679
+ "title": "Team Organization",
344680
+ "description": "Team Organization",
344588
344681
  "type": "object",
344589
344682
  "properties": {
344590
344683
  "login": {
@@ -345076,8 +345169,8 @@
345076
345169
  "example": "2017-08-17T12:37:15Z"
345077
345170
  },
345078
345171
  "organization": {
345079
- "title": "Organization Full",
345080
- "description": "Organization Full",
345172
+ "title": "Team Organization",
345173
+ "description": "Team Organization",
345081
345174
  "type": "object",
345082
345175
  "properties": {
345083
345176
  "login": {
@@ -360732,14 +360825,6 @@
360732
360825
  "write"
360733
360826
  ]
360734
360827
  },
360735
- "organization_custom_roles": {
360736
- "type": "string",
360737
- "description": "The level of permission to grant the access token for custom roles management.",
360738
- "enum": [
360739
- "read",
360740
- "write"
360741
- ]
360742
- },
360743
360828
  "deployments": {
360744
360829
  "type": "string",
360745
360830
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -379463,8 +379548,8 @@
379463
379548
  "example": "2017-08-17T12:37:15Z"
379464
379549
  },
379465
379550
  "organization": {
379466
- "title": "Organization Full",
379467
- "description": "Organization Full",
379551
+ "title": "Team Organization",
379552
+ "description": "Team Organization",
379468
379553
  "type": "object",
379469
379554
  "properties": {
379470
379555
  "login": {
@@ -391831,14 +391916,6 @@
391831
391916
  "write"
391832
391917
  ]
391833
391918
  },
391834
- "organization_custom_roles": {
391835
- "type": "string",
391836
- "description": "The level of permission to grant the access token for custom roles management.",
391837
- "enum": [
391838
- "read",
391839
- "write"
391840
- ]
391841
- },
391842
391919
  "deployments": {
391843
391920
  "type": "string",
391844
391921
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",