@octokit/openapi 5.12.0 → 5.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.
@@ -15656,6 +15656,7 @@
15656
15656
  "delete"
15657
15657
  ],
15658
15658
  "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": ["get"],
15659
+ "/repos/{owner}/{repo}/dependency-graph/snapshots": ["post"],
15659
15660
  "/repos/{owner}/{repo}/import": ["get", "put", "delete", "patch"],
15660
15661
  "/repos/{owner}/{repo}/import/authors": ["get"],
15661
15662
  "/repos/{owner}/{repo}/import/authors/{author_id}": ["patch"],
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.12.0",
4
+ "version": "5.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -21516,6 +21516,71 @@
21516
21516
  "created_at"
21517
21517
  ]
21518
21518
  }
21519
+ },
21520
+ "examples": {
21521
+ "default": {
21522
+ "value": [
21523
+ {
21524
+ "id": "22249084947",
21525
+ "type": "WatchEvent",
21526
+ "actor": {
21527
+ "id": 583231,
21528
+ "login": "octocat",
21529
+ "display_login": "octocat",
21530
+ "gravatar_id": "",
21531
+ "url": "https://api.github.com/users/octocat",
21532
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21533
+ },
21534
+ "repo": {
21535
+ "id": 1296269,
21536
+ "name": "octocat/Hello-World",
21537
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21538
+ },
21539
+ "payload": { "action": "started" },
21540
+ "public": true,
21541
+ "created_at": "2022-06-09T12:47:28Z"
21542
+ },
21543
+ {
21544
+ "id": "22249084964",
21545
+ "type": "PushEvent",
21546
+ "actor": {
21547
+ "id": 583231,
21548
+ "login": "octocat",
21549
+ "display_login": "octocat",
21550
+ "gravatar_id": "",
21551
+ "url": "https://api.github.com/users/octocat",
21552
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21553
+ },
21554
+ "repo": {
21555
+ "id": 1296269,
21556
+ "name": "octocat/Hello-World",
21557
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21558
+ },
21559
+ "payload": {
21560
+ "push_id": 10115855396,
21561
+ "size": 1,
21562
+ "distinct_size": 1,
21563
+ "ref": "refs/heads/master",
21564
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21565
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21566
+ "commits": [
21567
+ {
21568
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21569
+ "author": {
21570
+ "email": "octocat@github.com",
21571
+ "name": "Monalisa Octocat"
21572
+ },
21573
+ "message": "commit",
21574
+ "distinct": true,
21575
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21576
+ }
21577
+ ]
21578
+ },
21579
+ "public": true,
21580
+ "created_at": "2022-06-07T07:50:26Z"
21581
+ }
21582
+ ]
21583
+ }
21519
21584
  }
21520
21585
  }
21521
21586
  }
@@ -27574,6 +27639,71 @@
27574
27639
  "created_at"
27575
27640
  ]
27576
27641
  }
27642
+ },
27643
+ "examples": {
27644
+ "default": {
27645
+ "value": [
27646
+ {
27647
+ "id": "22249084964",
27648
+ "type": "PushEvent",
27649
+ "actor": {
27650
+ "id": 583231,
27651
+ "login": "octocat",
27652
+ "display_login": "octocat",
27653
+ "gravatar_id": "",
27654
+ "url": "https://api.github.com/users/octocat",
27655
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
27656
+ },
27657
+ "repo": {
27658
+ "id": 1296269,
27659
+ "name": "octocat/Hello-World",
27660
+ "url": "https://api.github.com/repos/octocat/Hello-World"
27661
+ },
27662
+ "payload": {
27663
+ "push_id": 10115855396,
27664
+ "size": 1,
27665
+ "distinct_size": 1,
27666
+ "ref": "refs/heads/master",
27667
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
27668
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
27669
+ "commits": [
27670
+ {
27671
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
27672
+ "author": {
27673
+ "email": "octocat@github.com",
27674
+ "name": "Monalisa Octocat"
27675
+ },
27676
+ "message": "commit",
27677
+ "distinct": true,
27678
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
27679
+ }
27680
+ ]
27681
+ },
27682
+ "public": true,
27683
+ "created_at": "2022-06-09T12:47:28Z"
27684
+ },
27685
+ {
27686
+ "id": "22237752260",
27687
+ "type": "WatchEvent",
27688
+ "actor": {
27689
+ "id": 583231,
27690
+ "login": "octocat",
27691
+ "display_login": "octocat",
27692
+ "gravatar_id": "",
27693
+ "url": "https://api.github.com/users/rrubenich",
27694
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
27695
+ },
27696
+ "repo": {
27697
+ "id": 1296269,
27698
+ "name": "octocat/Hello-World",
27699
+ "url": "https://api.github.com/repos/octocat/Hello-World"
27700
+ },
27701
+ "payload": { "action": "started" },
27702
+ "public": true,
27703
+ "created_at": "2022-06-08T23:29:25Z"
27704
+ }
27705
+ ]
27706
+ }
27577
27707
  }
27578
27708
  }
27579
27709
  }
@@ -29254,7 +29384,7 @@
29254
29384
  "parameters": [
29255
29385
  {
29256
29386
  "name": "thread_id",
29257
- "description": "The unique identifier of the thread.",
29387
+ "description": "The unique identifier of the pull request thread.",
29258
29388
  "in": "path",
29259
29389
  "required": true,
29260
29390
  "schema": { "type": "integer" }
@@ -174370,6 +174500,71 @@
174370
174500
  "created_at"
174371
174501
  ]
174372
174502
  }
174503
+ },
174504
+ "examples": {
174505
+ "default": {
174506
+ "value": [
174507
+ {
174508
+ "id": "22249084947",
174509
+ "type": "WatchEvent",
174510
+ "actor": {
174511
+ "id": 583231,
174512
+ "login": "octocat",
174513
+ "display_login": "octocat",
174514
+ "gravatar_id": "",
174515
+ "url": "https://api.github.com/users/octocat",
174516
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
174517
+ },
174518
+ "repo": {
174519
+ "id": 1296269,
174520
+ "name": "octocat/Hello-World",
174521
+ "url": "https://api.github.com/repos/octocat/Hello-World"
174522
+ },
174523
+ "payload": { "action": "started" },
174524
+ "public": true,
174525
+ "created_at": "2022-06-09T12:47:28Z"
174526
+ },
174527
+ {
174528
+ "id": "22249084964",
174529
+ "type": "PushEvent",
174530
+ "actor": {
174531
+ "id": 583231,
174532
+ "login": "octocat",
174533
+ "display_login": "octocat",
174534
+ "gravatar_id": "",
174535
+ "url": "https://api.github.com/users/octocat",
174536
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
174537
+ },
174538
+ "repo": {
174539
+ "id": 1296269,
174540
+ "name": "octocat/Hello-World",
174541
+ "url": "https://api.github.com/repos/octocat/Hello-World"
174542
+ },
174543
+ "payload": {
174544
+ "push_id": 10115855396,
174545
+ "size": 1,
174546
+ "distinct_size": 1,
174547
+ "ref": "refs/heads/master",
174548
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
174549
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
174550
+ "commits": [
174551
+ {
174552
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
174553
+ "author": {
174554
+ "email": "octocat@github.com",
174555
+ "name": "Monalisa Octocat"
174556
+ },
174557
+ "message": "commit",
174558
+ "distinct": true,
174559
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
174560
+ }
174561
+ ]
174562
+ },
174563
+ "public": false,
174564
+ "created_at": "2022-06-07T07:50:26Z"
174565
+ }
174566
+ ]
174567
+ }
174373
174568
  }
174374
174569
  }
174375
174570
  }
@@ -176961,6 +177156,84 @@
176961
177156
  "created_at"
176962
177157
  ]
176963
177158
  }
177159
+ },
177160
+ "examples": {
177161
+ "default": {
177162
+ "value": [
177163
+ {
177164
+ "id": "22249084964",
177165
+ "type": "PushEvent",
177166
+ "actor": {
177167
+ "id": 583231,
177168
+ "login": "octocat",
177169
+ "display_login": "octocat",
177170
+ "gravatar_id": "",
177171
+ "url": "https://api.github.com/users/octocat",
177172
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
177173
+ },
177174
+ "repo": {
177175
+ "id": 1296269,
177176
+ "name": "octocat/Hello-World",
177177
+ "url": "https://api.github.com/repos/octocat/Hello-World"
177178
+ },
177179
+ "payload": {
177180
+ "push_id": 10115855396,
177181
+ "size": 1,
177182
+ "distinct_size": 1,
177183
+ "ref": "refs/heads/master",
177184
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
177185
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
177186
+ "commits": [
177187
+ {
177188
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
177189
+ "author": {
177190
+ "email": "octocat@github.com",
177191
+ "name": "Monalisa Octocat"
177192
+ },
177193
+ "message": "commit",
177194
+ "distinct": true,
177195
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
177196
+ }
177197
+ ]
177198
+ },
177199
+ "public": false,
177200
+ "created_at": "2022-06-09T12:47:28Z"
177201
+ },
177202
+ {
177203
+ "id": "22196946742",
177204
+ "type": "CreateEvent",
177205
+ "actor": {
177206
+ "id": 583231,
177207
+ "login": "octocat",
177208
+ "display_login": "octocat",
177209
+ "gravatar_id": "",
177210
+ "url": "https://api.github.com/users/octocat",
177211
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
177212
+ },
177213
+ "repo": {
177214
+ "id": 1296269,
177215
+ "name": "octocat/Hello-World",
177216
+ "url": "https://api.github.com/repos/octocat/Hello-World"
177217
+ },
177218
+ "payload": {
177219
+ "ref": null,
177220
+ "ref_type": "repository",
177221
+ "master_branch": "master",
177222
+ "description": null,
177223
+ "pusher_type": "user"
177224
+ },
177225
+ "public": false,
177226
+ "created_at": "2022-06-07T07:50:26Z",
177227
+ "org": {
177228
+ "id": 9919,
177229
+ "login": "github",
177230
+ "gravatar_id": "",
177231
+ "url": "https://api.github.com/orgs/github",
177232
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
177233
+ }
177234
+ }
177235
+ ]
177236
+ }
176964
177237
  }
176965
177238
  }
176966
177239
  }
@@ -179545,6 +179818,71 @@
179545
179818
  "created_at"
179546
179819
  ]
179547
179820
  }
179821
+ },
179822
+ "examples": {
179823
+ "default": {
179824
+ "value": [
179825
+ {
179826
+ "id": "22249084947",
179827
+ "type": "WatchEvent",
179828
+ "actor": {
179829
+ "id": 583231,
179830
+ "login": "octocat",
179831
+ "display_login": "octocat",
179832
+ "gravatar_id": "",
179833
+ "url": "https://api.github.com/users/octocat",
179834
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
179835
+ },
179836
+ "repo": {
179837
+ "id": 1296269,
179838
+ "name": "octocat/Hello-World",
179839
+ "url": "https://api.github.com/repos/octocat/Hello-World"
179840
+ },
179841
+ "payload": { "action": "started" },
179842
+ "public": true,
179843
+ "created_at": "2022-06-09T12:47:28Z"
179844
+ },
179845
+ {
179846
+ "id": "22249084964",
179847
+ "type": "PushEvent",
179848
+ "actor": {
179849
+ "id": 583231,
179850
+ "login": "octocat",
179851
+ "display_login": "octocat",
179852
+ "gravatar_id": "",
179853
+ "url": "https://api.github.com/users/octocat",
179854
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
179855
+ },
179856
+ "repo": {
179857
+ "id": 1296269,
179858
+ "name": "octocat/Hello-World",
179859
+ "url": "https://api.github.com/repos/octocat/Hello-World"
179860
+ },
179861
+ "payload": {
179862
+ "push_id": 10115855396,
179863
+ "size": 1,
179864
+ "distinct_size": 1,
179865
+ "ref": "refs/heads/master",
179866
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
179867
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
179868
+ "commits": [
179869
+ {
179870
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
179871
+ "author": {
179872
+ "email": "octocat@github.com",
179873
+ "name": "Monalisa Octocat"
179874
+ },
179875
+ "message": "commit",
179876
+ "distinct": true,
179877
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
179878
+ }
179879
+ ]
179880
+ },
179881
+ "public": true,
179882
+ "created_at": "2022-06-08T23:29:25Z"
179883
+ }
179884
+ ]
179885
+ }
179548
179886
  }
179549
179887
  }
179550
179888
  }
@@ -182956,6 +183294,84 @@
182956
183294
  "created_at"
182957
183295
  ]
182958
183296
  }
183297
+ },
183298
+ "examples": {
183299
+ "default": {
183300
+ "value": [
183301
+ {
183302
+ "id": "22249084964",
183303
+ "type": "PushEvent",
183304
+ "actor": {
183305
+ "id": 583231,
183306
+ "login": "octocat",
183307
+ "display_login": "octocat",
183308
+ "gravatar_id": "",
183309
+ "url": "https://api.github.com/users/octocat",
183310
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
183311
+ },
183312
+ "repo": {
183313
+ "id": 1296269,
183314
+ "name": "octocat/Hello-World",
183315
+ "url": "https://api.github.com/repos/octocat/Hello-World"
183316
+ },
183317
+ "payload": {
183318
+ "push_id": 10115855396,
183319
+ "size": 1,
183320
+ "distinct_size": 1,
183321
+ "ref": "refs/heads/master",
183322
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
183323
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
183324
+ "commits": [
183325
+ {
183326
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
183327
+ "author": {
183328
+ "email": "octocat@github.com",
183329
+ "name": "Monalisa Octocat"
183330
+ },
183331
+ "message": "commit",
183332
+ "distinct": true,
183333
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
183334
+ }
183335
+ ]
183336
+ },
183337
+ "public": true,
183338
+ "created_at": "2022-06-09T12:47:28Z"
183339
+ },
183340
+ {
183341
+ "id": "22196946742",
183342
+ "type": "CreateEvent",
183343
+ "actor": {
183344
+ "id": 583231,
183345
+ "login": "octocat",
183346
+ "display_login": "octocat",
183347
+ "gravatar_id": "",
183348
+ "url": "https://api.github.com/users/octocat",
183349
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
183350
+ },
183351
+ "repo": {
183352
+ "id": 1296269,
183353
+ "name": "octocat/Hello-World",
183354
+ "url": "https://api.github.com/repos/octocat/Hello-World"
183355
+ },
183356
+ "payload": {
183357
+ "ref": null,
183358
+ "ref_type": "repository",
183359
+ "master_branch": "master",
183360
+ "description": null,
183361
+ "pusher_type": "user"
183362
+ },
183363
+ "public": false,
183364
+ "created_at": "2022-06-07T07:50:26Z",
183365
+ "org": {
183366
+ "id": 9919,
183367
+ "login": "github",
183368
+ "gravatar_id": "",
183369
+ "url": "https://api.github.com/orgs/github",
183370
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
183371
+ }
183372
+ }
183373
+ ]
183374
+ }
182959
183375
  }
182960
183376
  }
182961
183377
  }
@@ -185540,6 +185956,84 @@
185540
185956
  "created_at"
185541
185957
  ]
185542
185958
  }
185959
+ },
185960
+ "examples": {
185961
+ "default": {
185962
+ "value": [
185963
+ {
185964
+ "id": "22249084964",
185965
+ "type": "PushEvent",
185966
+ "actor": {
185967
+ "id": 583231,
185968
+ "login": "octocat",
185969
+ "display_login": "octocat",
185970
+ "gravatar_id": "",
185971
+ "url": "https://api.github.com/users/octocat",
185972
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
185973
+ },
185974
+ "repo": {
185975
+ "id": 1296269,
185976
+ "name": "octocat/Hello-World",
185977
+ "url": "https://api.github.com/repos/octocat/Hello-World"
185978
+ },
185979
+ "payload": {
185980
+ "push_id": 10115855396,
185981
+ "size": 1,
185982
+ "distinct_size": 1,
185983
+ "ref": "refs/heads/master",
185984
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
185985
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
185986
+ "commits": [
185987
+ {
185988
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
185989
+ "author": {
185990
+ "email": "octocat@github.com",
185991
+ "name": "Monalisa Octocat"
185992
+ },
185993
+ "message": "commit",
185994
+ "distinct": true,
185995
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
185996
+ }
185997
+ ]
185998
+ },
185999
+ "public": true,
186000
+ "created_at": "2022-06-09T12:47:28Z"
186001
+ },
186002
+ {
186003
+ "id": "22196946742",
186004
+ "type": "CreateEvent",
186005
+ "actor": {
186006
+ "id": 583231,
186007
+ "login": "octocat",
186008
+ "display_login": "octocat",
186009
+ "gravatar_id": "",
186010
+ "url": "https://api.github.com/users/octocat",
186011
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
186012
+ },
186013
+ "repo": {
186014
+ "id": 1296269,
186015
+ "name": "octocat/Hello-World",
186016
+ "url": "https://api.github.com/repos/octocat/Hello-World"
186017
+ },
186018
+ "payload": {
186019
+ "ref": null,
186020
+ "ref_type": "repository",
186021
+ "master_branch": "master",
186022
+ "description": null,
186023
+ "pusher_type": "user"
186024
+ },
186025
+ "public": false,
186026
+ "created_at": "2022-06-07T07:50:26Z",
186027
+ "org": {
186028
+ "id": 9919,
186029
+ "login": "github",
186030
+ "gravatar_id": "",
186031
+ "url": "https://api.github.com/orgs/github",
186032
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
186033
+ }
186034
+ }
186035
+ ]
186036
+ }
185543
186037
  }
185544
186038
  }
185545
186039
  }