@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.
@@ -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" },
@@ -1164,6 +1164,11 @@
1164
1164
  "schema": {
1165
1165
  "type": "array",
1166
1166
  "items": { "$ref": "#/components/schemas/event" }
1167
+ },
1168
+ "examples": {
1169
+ "default": {
1170
+ "$ref": "#/components/examples/public-events-items"
1171
+ }
1167
1172
  }
1168
1173
  }
1169
1174
  }
@@ -1391,6 +1396,11 @@
1391
1396
  "schema": {
1392
1397
  "type": "array",
1393
1398
  "items": { "$ref": "#/components/schemas/event" }
1399
+ },
1400
+ "examples": {
1401
+ "default": {
1402
+ "$ref": "#/components/examples/public-repo-events-items"
1403
+ }
1394
1404
  }
1395
1405
  }
1396
1406
  }
@@ -6392,6 +6402,11 @@
6392
6402
  "schema": {
6393
6403
  "type": "array",
6394
6404
  "items": { "$ref": "#/components/schemas/event" }
6405
+ },
6406
+ "examples": {
6407
+ "default": {
6408
+ "$ref": "#/components/examples/user-events-items"
6409
+ }
6395
6410
  }
6396
6411
  }
6397
6412
  }
@@ -6430,6 +6445,11 @@
6430
6445
  "schema": {
6431
6446
  "type": "array",
6432
6447
  "items": { "$ref": "#/components/schemas/event" }
6448
+ },
6449
+ "examples": {
6450
+ "default": {
6451
+ "$ref": "#/components/examples/user-org-events-items"
6452
+ }
6433
6453
  }
6434
6454
  }
6435
6455
  }
@@ -6467,6 +6487,11 @@
6467
6487
  "schema": {
6468
6488
  "type": "array",
6469
6489
  "items": { "$ref": "#/components/schemas/event" }
6490
+ },
6491
+ "examples": {
6492
+ "default": {
6493
+ "$ref": "#/components/examples/user-public-events-items"
6494
+ }
6470
6495
  }
6471
6496
  }
6472
6497
  }
@@ -6504,6 +6529,11 @@
6504
6529
  "schema": {
6505
6530
  "type": "array",
6506
6531
  "items": { "$ref": "#/components/schemas/event" }
6532
+ },
6533
+ "examples": {
6534
+ "default": {
6535
+ "$ref": "#/components/examples/user-received-events-items"
6536
+ }
6507
6537
  }
6508
6538
  }
6509
6539
  }
@@ -6541,6 +6571,11 @@
6541
6571
  "schema": {
6542
6572
  "type": "array",
6543
6573
  "items": { "$ref": "#/components/schemas/event" }
6574
+ },
6575
+ "examples": {
6576
+ "default": {
6577
+ "$ref": "#/components/examples/user-received-public-events-items"
6578
+ }
6544
6579
  }
6545
6580
  }
6546
6581
  }
@@ -6796,7 +6831,7 @@
6796
6831
  },
6797
6832
  "thread-id": {
6798
6833
  "name": "thread_id",
6799
- "description": "The unique identifier of the thread.",
6834
+ "description": "The unique identifier of the pull request thread.",
6800
6835
  "in": "path",
6801
6836
  "required": true,
6802
6837
  "schema": { "type": "integer" }
@@ -13282,6 +13317,69 @@
13282
13317
  "expires_at": "2020-01-29T12:13:35.123-08:00"
13283
13318
  }
13284
13319
  },
13320
+ "public-events-items": {
13321
+ "value": [
13322
+ {
13323
+ "id": "22249084947",
13324
+ "type": "WatchEvent",
13325
+ "actor": {
13326
+ "id": 583231,
13327
+ "login": "octocat",
13328
+ "display_login": "octocat",
13329
+ "gravatar_id": "",
13330
+ "url": "https://api.github.com/users/octocat",
13331
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
13332
+ },
13333
+ "repo": {
13334
+ "id": 1296269,
13335
+ "name": "octocat/Hello-World",
13336
+ "url": "https://api.github.com/repos/octocat/Hello-World"
13337
+ },
13338
+ "payload": { "action": "started" },
13339
+ "public": true,
13340
+ "created_at": "2022-06-09T12:47:28Z"
13341
+ },
13342
+ {
13343
+ "id": "22249084964",
13344
+ "type": "PushEvent",
13345
+ "actor": {
13346
+ "id": 583231,
13347
+ "login": "octocat",
13348
+ "display_login": "octocat",
13349
+ "gravatar_id": "",
13350
+ "url": "https://api.github.com/users/octocat",
13351
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
13352
+ },
13353
+ "repo": {
13354
+ "id": 1296269,
13355
+ "name": "octocat/Hello-World",
13356
+ "url": "https://api.github.com/repos/octocat/Hello-World"
13357
+ },
13358
+ "payload": {
13359
+ "push_id": 10115855396,
13360
+ "size": 1,
13361
+ "distinct_size": 1,
13362
+ "ref": "refs/heads/master",
13363
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
13364
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
13365
+ "commits": [
13366
+ {
13367
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
13368
+ "author": {
13369
+ "email": "octocat@github.com",
13370
+ "name": "Monalisa Octocat"
13371
+ },
13372
+ "message": "commit",
13373
+ "distinct": true,
13374
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
13375
+ }
13376
+ ]
13377
+ },
13378
+ "public": true,
13379
+ "created_at": "2022-06-07T07:50:26Z"
13380
+ }
13381
+ ]
13382
+ },
13285
13383
  "repository-paginated-2": {
13286
13384
  "value": {
13287
13385
  "total_count": 1,
@@ -13655,6 +13753,69 @@
13655
13753
  }
13656
13754
  ]
13657
13755
  },
13756
+ "public-repo-events-items": {
13757
+ "value": [
13758
+ {
13759
+ "id": "22249084964",
13760
+ "type": "PushEvent",
13761
+ "actor": {
13762
+ "id": 583231,
13763
+ "login": "octocat",
13764
+ "display_login": "octocat",
13765
+ "gravatar_id": "",
13766
+ "url": "https://api.github.com/users/octocat",
13767
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
13768
+ },
13769
+ "repo": {
13770
+ "id": 1296269,
13771
+ "name": "octocat/Hello-World",
13772
+ "url": "https://api.github.com/repos/octocat/Hello-World"
13773
+ },
13774
+ "payload": {
13775
+ "push_id": 10115855396,
13776
+ "size": 1,
13777
+ "distinct_size": 1,
13778
+ "ref": "refs/heads/master",
13779
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
13780
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
13781
+ "commits": [
13782
+ {
13783
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
13784
+ "author": {
13785
+ "email": "octocat@github.com",
13786
+ "name": "Monalisa Octocat"
13787
+ },
13788
+ "message": "commit",
13789
+ "distinct": true,
13790
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
13791
+ }
13792
+ ]
13793
+ },
13794
+ "public": true,
13795
+ "created_at": "2022-06-09T12:47:28Z"
13796
+ },
13797
+ {
13798
+ "id": "22237752260",
13799
+ "type": "WatchEvent",
13800
+ "actor": {
13801
+ "id": 583231,
13802
+ "login": "octocat",
13803
+ "display_login": "octocat",
13804
+ "gravatar_id": "",
13805
+ "url": "https://api.github.com/users/rrubenich",
13806
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
13807
+ },
13808
+ "repo": {
13809
+ "id": 1296269,
13810
+ "name": "octocat/Hello-World",
13811
+ "url": "https://api.github.com/repos/octocat/Hello-World"
13812
+ },
13813
+ "payload": { "action": "started" },
13814
+ "public": true,
13815
+ "created_at": "2022-06-08T23:29:25Z"
13816
+ }
13817
+ ]
13818
+ },
13658
13819
  "thread-items": {
13659
13820
  "value": [
13660
13821
  {
@@ -21341,6 +21502,360 @@
21341
21502
  }
21342
21503
  }
21343
21504
  ]
21505
+ },
21506
+ "user-events-items": {
21507
+ "value": [
21508
+ {
21509
+ "id": "22249084947",
21510
+ "type": "WatchEvent",
21511
+ "actor": {
21512
+ "id": 583231,
21513
+ "login": "octocat",
21514
+ "display_login": "octocat",
21515
+ "gravatar_id": "",
21516
+ "url": "https://api.github.com/users/octocat",
21517
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21518
+ },
21519
+ "repo": {
21520
+ "id": 1296269,
21521
+ "name": "octocat/Hello-World",
21522
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21523
+ },
21524
+ "payload": { "action": "started" },
21525
+ "public": true,
21526
+ "created_at": "2022-06-09T12:47:28Z"
21527
+ },
21528
+ {
21529
+ "id": "22249084964",
21530
+ "type": "PushEvent",
21531
+ "actor": {
21532
+ "id": 583231,
21533
+ "login": "octocat",
21534
+ "display_login": "octocat",
21535
+ "gravatar_id": "",
21536
+ "url": "https://api.github.com/users/octocat",
21537
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21538
+ },
21539
+ "repo": {
21540
+ "id": 1296269,
21541
+ "name": "octocat/Hello-World",
21542
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21543
+ },
21544
+ "payload": {
21545
+ "push_id": 10115855396,
21546
+ "size": 1,
21547
+ "distinct_size": 1,
21548
+ "ref": "refs/heads/master",
21549
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21550
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21551
+ "commits": [
21552
+ {
21553
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21554
+ "author": {
21555
+ "email": "octocat@github.com",
21556
+ "name": "Monalisa Octocat"
21557
+ },
21558
+ "message": "commit",
21559
+ "distinct": true,
21560
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21561
+ }
21562
+ ]
21563
+ },
21564
+ "public": false,
21565
+ "created_at": "2022-06-07T07:50:26Z"
21566
+ }
21567
+ ]
21568
+ },
21569
+ "user-org-events-items": {
21570
+ "value": [
21571
+ {
21572
+ "id": "22249084964",
21573
+ "type": "PushEvent",
21574
+ "actor": {
21575
+ "id": 583231,
21576
+ "login": "octocat",
21577
+ "display_login": "octocat",
21578
+ "gravatar_id": "",
21579
+ "url": "https://api.github.com/users/octocat",
21580
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21581
+ },
21582
+ "repo": {
21583
+ "id": 1296269,
21584
+ "name": "octocat/Hello-World",
21585
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21586
+ },
21587
+ "payload": {
21588
+ "push_id": 10115855396,
21589
+ "size": 1,
21590
+ "distinct_size": 1,
21591
+ "ref": "refs/heads/master",
21592
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21593
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21594
+ "commits": [
21595
+ {
21596
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21597
+ "author": {
21598
+ "email": "octocat@github.com",
21599
+ "name": "Monalisa Octocat"
21600
+ },
21601
+ "message": "commit",
21602
+ "distinct": true,
21603
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21604
+ }
21605
+ ]
21606
+ },
21607
+ "public": false,
21608
+ "created_at": "2022-06-09T12:47:28Z"
21609
+ },
21610
+ {
21611
+ "id": "22196946742",
21612
+ "type": "CreateEvent",
21613
+ "actor": {
21614
+ "id": 583231,
21615
+ "login": "octocat",
21616
+ "display_login": "octocat",
21617
+ "gravatar_id": "",
21618
+ "url": "https://api.github.com/users/octocat",
21619
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21620
+ },
21621
+ "repo": {
21622
+ "id": 1296269,
21623
+ "name": "octocat/Hello-World",
21624
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21625
+ },
21626
+ "payload": {
21627
+ "ref": null,
21628
+ "ref_type": "repository",
21629
+ "master_branch": "master",
21630
+ "description": null,
21631
+ "pusher_type": "user"
21632
+ },
21633
+ "public": false,
21634
+ "created_at": "2022-06-07T07:50:26Z",
21635
+ "org": {
21636
+ "id": 9919,
21637
+ "login": "github",
21638
+ "gravatar_id": "",
21639
+ "url": "https://api.github.com/orgs/github",
21640
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
21641
+ }
21642
+ }
21643
+ ]
21644
+ },
21645
+ "user-public-events-items": {
21646
+ "value": [
21647
+ {
21648
+ "id": "22249084947",
21649
+ "type": "WatchEvent",
21650
+ "actor": {
21651
+ "id": 583231,
21652
+ "login": "octocat",
21653
+ "display_login": "octocat",
21654
+ "gravatar_id": "",
21655
+ "url": "https://api.github.com/users/octocat",
21656
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21657
+ },
21658
+ "repo": {
21659
+ "id": 1296269,
21660
+ "name": "octocat/Hello-World",
21661
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21662
+ },
21663
+ "payload": { "action": "started" },
21664
+ "public": true,
21665
+ "created_at": "2022-06-09T12:47:28Z"
21666
+ },
21667
+ {
21668
+ "id": "22249084964",
21669
+ "type": "PushEvent",
21670
+ "actor": {
21671
+ "id": 583231,
21672
+ "login": "octocat",
21673
+ "display_login": "octocat",
21674
+ "gravatar_id": "",
21675
+ "url": "https://api.github.com/users/octocat",
21676
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21677
+ },
21678
+ "repo": {
21679
+ "id": 1296269,
21680
+ "name": "octocat/Hello-World",
21681
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21682
+ },
21683
+ "payload": {
21684
+ "push_id": 10115855396,
21685
+ "size": 1,
21686
+ "distinct_size": 1,
21687
+ "ref": "refs/heads/master",
21688
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21689
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21690
+ "commits": [
21691
+ {
21692
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21693
+ "author": {
21694
+ "email": "octocat@github.com",
21695
+ "name": "Monalisa Octocat"
21696
+ },
21697
+ "message": "commit",
21698
+ "distinct": true,
21699
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21700
+ }
21701
+ ]
21702
+ },
21703
+ "public": true,
21704
+ "created_at": "2022-06-08T23:29:25Z"
21705
+ }
21706
+ ]
21707
+ },
21708
+ "user-received-events-items": {
21709
+ "value": [
21710
+ {
21711
+ "id": "22249084964",
21712
+ "type": "PushEvent",
21713
+ "actor": {
21714
+ "id": 583231,
21715
+ "login": "octocat",
21716
+ "display_login": "octocat",
21717
+ "gravatar_id": "",
21718
+ "url": "https://api.github.com/users/octocat",
21719
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21720
+ },
21721
+ "repo": {
21722
+ "id": 1296269,
21723
+ "name": "octocat/Hello-World",
21724
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21725
+ },
21726
+ "payload": {
21727
+ "push_id": 10115855396,
21728
+ "size": 1,
21729
+ "distinct_size": 1,
21730
+ "ref": "refs/heads/master",
21731
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21732
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21733
+ "commits": [
21734
+ {
21735
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21736
+ "author": {
21737
+ "email": "octocat@github.com",
21738
+ "name": "Monalisa Octocat"
21739
+ },
21740
+ "message": "commit",
21741
+ "distinct": true,
21742
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21743
+ }
21744
+ ]
21745
+ },
21746
+ "public": true,
21747
+ "created_at": "2022-06-09T12:47:28Z"
21748
+ },
21749
+ {
21750
+ "id": "22196946742",
21751
+ "type": "CreateEvent",
21752
+ "actor": {
21753
+ "id": 583231,
21754
+ "login": "octocat",
21755
+ "display_login": "octocat",
21756
+ "gravatar_id": "",
21757
+ "url": "https://api.github.com/users/octocat",
21758
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21759
+ },
21760
+ "repo": {
21761
+ "id": 1296269,
21762
+ "name": "octocat/Hello-World",
21763
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21764
+ },
21765
+ "payload": {
21766
+ "ref": null,
21767
+ "ref_type": "repository",
21768
+ "master_branch": "master",
21769
+ "description": null,
21770
+ "pusher_type": "user"
21771
+ },
21772
+ "public": false,
21773
+ "created_at": "2022-06-07T07:50:26Z",
21774
+ "org": {
21775
+ "id": 9919,
21776
+ "login": "github",
21777
+ "gravatar_id": "",
21778
+ "url": "https://api.github.com/orgs/github",
21779
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
21780
+ }
21781
+ }
21782
+ ]
21783
+ },
21784
+ "user-received-public-events-items": {
21785
+ "value": [
21786
+ {
21787
+ "id": "22249084964",
21788
+ "type": "PushEvent",
21789
+ "actor": {
21790
+ "id": 583231,
21791
+ "login": "octocat",
21792
+ "display_login": "octocat",
21793
+ "gravatar_id": "",
21794
+ "url": "https://api.github.com/users/octocat",
21795
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21796
+ },
21797
+ "repo": {
21798
+ "id": 1296269,
21799
+ "name": "octocat/Hello-World",
21800
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21801
+ },
21802
+ "payload": {
21803
+ "push_id": 10115855396,
21804
+ "size": 1,
21805
+ "distinct_size": 1,
21806
+ "ref": "refs/heads/master",
21807
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21808
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
21809
+ "commits": [
21810
+ {
21811
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
21812
+ "author": {
21813
+ "email": "octocat@github.com",
21814
+ "name": "Monalisa Octocat"
21815
+ },
21816
+ "message": "commit",
21817
+ "distinct": true,
21818
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
21819
+ }
21820
+ ]
21821
+ },
21822
+ "public": true,
21823
+ "created_at": "2022-06-09T12:47:28Z"
21824
+ },
21825
+ {
21826
+ "id": "22196946742",
21827
+ "type": "CreateEvent",
21828
+ "actor": {
21829
+ "id": 583231,
21830
+ "login": "octocat",
21831
+ "display_login": "octocat",
21832
+ "gravatar_id": "",
21833
+ "url": "https://api.github.com/users/octocat",
21834
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
21835
+ },
21836
+ "repo": {
21837
+ "id": 1296269,
21838
+ "name": "octocat/Hello-World",
21839
+ "url": "https://api.github.com/repos/octocat/Hello-World"
21840
+ },
21841
+ "payload": {
21842
+ "ref": null,
21843
+ "ref_type": "repository",
21844
+ "master_branch": "master",
21845
+ "description": null,
21846
+ "pusher_type": "user"
21847
+ },
21848
+ "public": false,
21849
+ "created_at": "2022-06-07T07:50:26Z",
21850
+ "org": {
21851
+ "id": 9919,
21852
+ "login": "github",
21853
+ "gravatar_id": "",
21854
+ "url": "https://api.github.com/orgs/github",
21855
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
21856
+ }
21857
+ }
21858
+ ]
21344
21859
  }
21345
21860
  },
21346
21861
  "headers": {