@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" },
@@ -3866,6 +3866,11 @@
3866
3866
  "schema": {
3867
3867
  "type": "array",
3868
3868
  "items": { "$ref": "#/components/schemas/event" }
3869
+ },
3870
+ "examples": {
3871
+ "default": {
3872
+ "$ref": "#/components/examples/public-events-items"
3873
+ }
3869
3874
  }
3870
3875
  }
3871
3876
  }
@@ -4135,6 +4140,11 @@
4135
4140
  "schema": {
4136
4141
  "type": "array",
4137
4142
  "items": { "$ref": "#/components/schemas/event" }
4143
+ },
4144
+ "examples": {
4145
+ "default": {
4146
+ "$ref": "#/components/examples/public-repo-events-items"
4147
+ }
4138
4148
  }
4139
4149
  }
4140
4150
  }
@@ -12950,6 +12960,11 @@
12950
12960
  "schema": {
12951
12961
  "type": "array",
12952
12962
  "items": { "$ref": "#/components/schemas/event" }
12963
+ },
12964
+ "examples": {
12965
+ "default": {
12966
+ "$ref": "#/components/examples/user-events-items"
12967
+ }
12953
12968
  }
12954
12969
  }
12955
12970
  }
@@ -12990,6 +13005,11 @@
12990
13005
  "schema": {
12991
13006
  "type": "array",
12992
13007
  "items": { "$ref": "#/components/schemas/event" }
13008
+ },
13009
+ "examples": {
13010
+ "default": {
13011
+ "$ref": "#/components/examples/user-org-events-items"
13012
+ }
12993
13013
  }
12994
13014
  }
12995
13015
  }
@@ -13029,6 +13049,11 @@
13029
13049
  "schema": {
13030
13050
  "type": "array",
13031
13051
  "items": { "$ref": "#/components/schemas/event" }
13052
+ },
13053
+ "examples": {
13054
+ "default": {
13055
+ "$ref": "#/components/examples/user-public-events-items"
13056
+ }
13032
13057
  }
13033
13058
  }
13034
13059
  }
@@ -13146,6 +13171,11 @@
13146
13171
  "schema": {
13147
13172
  "type": "array",
13148
13173
  "items": { "$ref": "#/components/schemas/event" }
13174
+ },
13175
+ "examples": {
13176
+ "default": {
13177
+ "$ref": "#/components/examples/user-received-events-items"
13178
+ }
13149
13179
  }
13150
13180
  }
13151
13181
  }
@@ -13185,6 +13215,11 @@
13185
13215
  "schema": {
13186
13216
  "type": "array",
13187
13217
  "items": { "$ref": "#/components/schemas/event" }
13218
+ },
13219
+ "examples": {
13220
+ "default": {
13221
+ "$ref": "#/components/examples/user-received-public-events-items"
13222
+ }
13188
13223
  }
13189
13224
  }
13190
13225
  }
@@ -13695,7 +13730,7 @@
13695
13730
  },
13696
13731
  "thread-id": {
13697
13732
  "name": "thread_id",
13698
- "description": "The unique identifier of the thread.",
13733
+ "description": "The unique identifier of the pull request thread.",
13699
13734
  "in": "path",
13700
13735
  "required": true,
13701
13736
  "schema": { "type": "integer" }
@@ -23325,6 +23360,69 @@
23325
23360
  "expires_at": "2020-01-29T12:13:35.123-08:00"
23326
23361
  }
23327
23362
  },
23363
+ "public-events-items": {
23364
+ "value": [
23365
+ {
23366
+ "id": "22249084947",
23367
+ "type": "WatchEvent",
23368
+ "actor": {
23369
+ "id": 583231,
23370
+ "login": "octocat",
23371
+ "display_login": "octocat",
23372
+ "gravatar_id": "",
23373
+ "url": "https://api.github.com/users/octocat",
23374
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
23375
+ },
23376
+ "repo": {
23377
+ "id": 1296269,
23378
+ "name": "octocat/Hello-World",
23379
+ "url": "https://api.github.com/repos/octocat/Hello-World"
23380
+ },
23381
+ "payload": { "action": "started" },
23382
+ "public": true,
23383
+ "created_at": "2022-06-09T12:47:28Z"
23384
+ },
23385
+ {
23386
+ "id": "22249084964",
23387
+ "type": "PushEvent",
23388
+ "actor": {
23389
+ "id": 583231,
23390
+ "login": "octocat",
23391
+ "display_login": "octocat",
23392
+ "gravatar_id": "",
23393
+ "url": "https://api.github.com/users/octocat",
23394
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
23395
+ },
23396
+ "repo": {
23397
+ "id": 1296269,
23398
+ "name": "octocat/Hello-World",
23399
+ "url": "https://api.github.com/repos/octocat/Hello-World"
23400
+ },
23401
+ "payload": {
23402
+ "push_id": 10115855396,
23403
+ "size": 1,
23404
+ "distinct_size": 1,
23405
+ "ref": "refs/heads/master",
23406
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
23407
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
23408
+ "commits": [
23409
+ {
23410
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
23411
+ "author": {
23412
+ "email": "octocat@github.com",
23413
+ "name": "Monalisa Octocat"
23414
+ },
23415
+ "message": "commit",
23416
+ "distinct": true,
23417
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
23418
+ }
23419
+ ]
23420
+ },
23421
+ "public": true,
23422
+ "created_at": "2022-06-07T07:50:26Z"
23423
+ }
23424
+ ]
23425
+ },
23328
23426
  "repository-paginated-2": {
23329
23427
  "value": {
23330
23428
  "total_count": 1,
@@ -23708,6 +23806,69 @@
23708
23806
  "installed_version": "3.2.0"
23709
23807
  }
23710
23808
  },
23809
+ "public-repo-events-items": {
23810
+ "value": [
23811
+ {
23812
+ "id": "22249084964",
23813
+ "type": "PushEvent",
23814
+ "actor": {
23815
+ "id": 583231,
23816
+ "login": "octocat",
23817
+ "display_login": "octocat",
23818
+ "gravatar_id": "",
23819
+ "url": "https://api.github.com/users/octocat",
23820
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
23821
+ },
23822
+ "repo": {
23823
+ "id": 1296269,
23824
+ "name": "octocat/Hello-World",
23825
+ "url": "https://api.github.com/repos/octocat/Hello-World"
23826
+ },
23827
+ "payload": {
23828
+ "push_id": 10115855396,
23829
+ "size": 1,
23830
+ "distinct_size": 1,
23831
+ "ref": "refs/heads/master",
23832
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
23833
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
23834
+ "commits": [
23835
+ {
23836
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
23837
+ "author": {
23838
+ "email": "octocat@github.com",
23839
+ "name": "Monalisa Octocat"
23840
+ },
23841
+ "message": "commit",
23842
+ "distinct": true,
23843
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
23844
+ }
23845
+ ]
23846
+ },
23847
+ "public": true,
23848
+ "created_at": "2022-06-09T12:47:28Z"
23849
+ },
23850
+ {
23851
+ "id": "22237752260",
23852
+ "type": "WatchEvent",
23853
+ "actor": {
23854
+ "id": 583231,
23855
+ "login": "octocat",
23856
+ "display_login": "octocat",
23857
+ "gravatar_id": "",
23858
+ "url": "https://api.github.com/users/rrubenich",
23859
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
23860
+ },
23861
+ "repo": {
23862
+ "id": 1296269,
23863
+ "name": "octocat/Hello-World",
23864
+ "url": "https://api.github.com/repos/octocat/Hello-World"
23865
+ },
23866
+ "payload": { "action": "started" },
23867
+ "public": true,
23868
+ "created_at": "2022-06-08T23:29:25Z"
23869
+ }
23870
+ ]
23871
+ },
23711
23872
  "thread-items": {
23712
23873
  "value": [
23713
23874
  {
@@ -32829,6 +32990,360 @@
32829
32990
  "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
32830
32991
  }
32831
32992
  ]
32993
+ },
32994
+ "user-events-items": {
32995
+ "value": [
32996
+ {
32997
+ "id": "22249084947",
32998
+ "type": "WatchEvent",
32999
+ "actor": {
33000
+ "id": 583231,
33001
+ "login": "octocat",
33002
+ "display_login": "octocat",
33003
+ "gravatar_id": "",
33004
+ "url": "https://api.github.com/users/octocat",
33005
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33006
+ },
33007
+ "repo": {
33008
+ "id": 1296269,
33009
+ "name": "octocat/Hello-World",
33010
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33011
+ },
33012
+ "payload": { "action": "started" },
33013
+ "public": true,
33014
+ "created_at": "2022-06-09T12:47:28Z"
33015
+ },
33016
+ {
33017
+ "id": "22249084964",
33018
+ "type": "PushEvent",
33019
+ "actor": {
33020
+ "id": 583231,
33021
+ "login": "octocat",
33022
+ "display_login": "octocat",
33023
+ "gravatar_id": "",
33024
+ "url": "https://api.github.com/users/octocat",
33025
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33026
+ },
33027
+ "repo": {
33028
+ "id": 1296269,
33029
+ "name": "octocat/Hello-World",
33030
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33031
+ },
33032
+ "payload": {
33033
+ "push_id": 10115855396,
33034
+ "size": 1,
33035
+ "distinct_size": 1,
33036
+ "ref": "refs/heads/master",
33037
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33038
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
33039
+ "commits": [
33040
+ {
33041
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33042
+ "author": {
33043
+ "email": "octocat@github.com",
33044
+ "name": "Monalisa Octocat"
33045
+ },
33046
+ "message": "commit",
33047
+ "distinct": true,
33048
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
33049
+ }
33050
+ ]
33051
+ },
33052
+ "public": false,
33053
+ "created_at": "2022-06-07T07:50:26Z"
33054
+ }
33055
+ ]
33056
+ },
33057
+ "user-org-events-items": {
33058
+ "value": [
33059
+ {
33060
+ "id": "22249084964",
33061
+ "type": "PushEvent",
33062
+ "actor": {
33063
+ "id": 583231,
33064
+ "login": "octocat",
33065
+ "display_login": "octocat",
33066
+ "gravatar_id": "",
33067
+ "url": "https://api.github.com/users/octocat",
33068
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33069
+ },
33070
+ "repo": {
33071
+ "id": 1296269,
33072
+ "name": "octocat/Hello-World",
33073
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33074
+ },
33075
+ "payload": {
33076
+ "push_id": 10115855396,
33077
+ "size": 1,
33078
+ "distinct_size": 1,
33079
+ "ref": "refs/heads/master",
33080
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33081
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
33082
+ "commits": [
33083
+ {
33084
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33085
+ "author": {
33086
+ "email": "octocat@github.com",
33087
+ "name": "Monalisa Octocat"
33088
+ },
33089
+ "message": "commit",
33090
+ "distinct": true,
33091
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
33092
+ }
33093
+ ]
33094
+ },
33095
+ "public": false,
33096
+ "created_at": "2022-06-09T12:47:28Z"
33097
+ },
33098
+ {
33099
+ "id": "22196946742",
33100
+ "type": "CreateEvent",
33101
+ "actor": {
33102
+ "id": 583231,
33103
+ "login": "octocat",
33104
+ "display_login": "octocat",
33105
+ "gravatar_id": "",
33106
+ "url": "https://api.github.com/users/octocat",
33107
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33108
+ },
33109
+ "repo": {
33110
+ "id": 1296269,
33111
+ "name": "octocat/Hello-World",
33112
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33113
+ },
33114
+ "payload": {
33115
+ "ref": null,
33116
+ "ref_type": "repository",
33117
+ "master_branch": "master",
33118
+ "description": null,
33119
+ "pusher_type": "user"
33120
+ },
33121
+ "public": false,
33122
+ "created_at": "2022-06-07T07:50:26Z",
33123
+ "org": {
33124
+ "id": 9919,
33125
+ "login": "github",
33126
+ "gravatar_id": "",
33127
+ "url": "https://api.github.com/orgs/github",
33128
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
33129
+ }
33130
+ }
33131
+ ]
33132
+ },
33133
+ "user-public-events-items": {
33134
+ "value": [
33135
+ {
33136
+ "id": "22249084947",
33137
+ "type": "WatchEvent",
33138
+ "actor": {
33139
+ "id": 583231,
33140
+ "login": "octocat",
33141
+ "display_login": "octocat",
33142
+ "gravatar_id": "",
33143
+ "url": "https://api.github.com/users/octocat",
33144
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33145
+ },
33146
+ "repo": {
33147
+ "id": 1296269,
33148
+ "name": "octocat/Hello-World",
33149
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33150
+ },
33151
+ "payload": { "action": "started" },
33152
+ "public": true,
33153
+ "created_at": "2022-06-09T12:47:28Z"
33154
+ },
33155
+ {
33156
+ "id": "22249084964",
33157
+ "type": "PushEvent",
33158
+ "actor": {
33159
+ "id": 583231,
33160
+ "login": "octocat",
33161
+ "display_login": "octocat",
33162
+ "gravatar_id": "",
33163
+ "url": "https://api.github.com/users/octocat",
33164
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33165
+ },
33166
+ "repo": {
33167
+ "id": 1296269,
33168
+ "name": "octocat/Hello-World",
33169
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33170
+ },
33171
+ "payload": {
33172
+ "push_id": 10115855396,
33173
+ "size": 1,
33174
+ "distinct_size": 1,
33175
+ "ref": "refs/heads/master",
33176
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33177
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
33178
+ "commits": [
33179
+ {
33180
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33181
+ "author": {
33182
+ "email": "octocat@github.com",
33183
+ "name": "Monalisa Octocat"
33184
+ },
33185
+ "message": "commit",
33186
+ "distinct": true,
33187
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
33188
+ }
33189
+ ]
33190
+ },
33191
+ "public": true,
33192
+ "created_at": "2022-06-08T23:29:25Z"
33193
+ }
33194
+ ]
33195
+ },
33196
+ "user-received-events-items": {
33197
+ "value": [
33198
+ {
33199
+ "id": "22249084964",
33200
+ "type": "PushEvent",
33201
+ "actor": {
33202
+ "id": 583231,
33203
+ "login": "octocat",
33204
+ "display_login": "octocat",
33205
+ "gravatar_id": "",
33206
+ "url": "https://api.github.com/users/octocat",
33207
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33208
+ },
33209
+ "repo": {
33210
+ "id": 1296269,
33211
+ "name": "octocat/Hello-World",
33212
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33213
+ },
33214
+ "payload": {
33215
+ "push_id": 10115855396,
33216
+ "size": 1,
33217
+ "distinct_size": 1,
33218
+ "ref": "refs/heads/master",
33219
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33220
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
33221
+ "commits": [
33222
+ {
33223
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33224
+ "author": {
33225
+ "email": "octocat@github.com",
33226
+ "name": "Monalisa Octocat"
33227
+ },
33228
+ "message": "commit",
33229
+ "distinct": true,
33230
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
33231
+ }
33232
+ ]
33233
+ },
33234
+ "public": true,
33235
+ "created_at": "2022-06-09T12:47:28Z"
33236
+ },
33237
+ {
33238
+ "id": "22196946742",
33239
+ "type": "CreateEvent",
33240
+ "actor": {
33241
+ "id": 583231,
33242
+ "login": "octocat",
33243
+ "display_login": "octocat",
33244
+ "gravatar_id": "",
33245
+ "url": "https://api.github.com/users/octocat",
33246
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33247
+ },
33248
+ "repo": {
33249
+ "id": 1296269,
33250
+ "name": "octocat/Hello-World",
33251
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33252
+ },
33253
+ "payload": {
33254
+ "ref": null,
33255
+ "ref_type": "repository",
33256
+ "master_branch": "master",
33257
+ "description": null,
33258
+ "pusher_type": "user"
33259
+ },
33260
+ "public": false,
33261
+ "created_at": "2022-06-07T07:50:26Z",
33262
+ "org": {
33263
+ "id": 9919,
33264
+ "login": "github",
33265
+ "gravatar_id": "",
33266
+ "url": "https://api.github.com/orgs/github",
33267
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
33268
+ }
33269
+ }
33270
+ ]
33271
+ },
33272
+ "user-received-public-events-items": {
33273
+ "value": [
33274
+ {
33275
+ "id": "22249084964",
33276
+ "type": "PushEvent",
33277
+ "actor": {
33278
+ "id": 583231,
33279
+ "login": "octocat",
33280
+ "display_login": "octocat",
33281
+ "gravatar_id": "",
33282
+ "url": "https://api.github.com/users/octocat",
33283
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33284
+ },
33285
+ "repo": {
33286
+ "id": 1296269,
33287
+ "name": "octocat/Hello-World",
33288
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33289
+ },
33290
+ "payload": {
33291
+ "push_id": 10115855396,
33292
+ "size": 1,
33293
+ "distinct_size": 1,
33294
+ "ref": "refs/heads/master",
33295
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33296
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
33297
+ "commits": [
33298
+ {
33299
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
33300
+ "author": {
33301
+ "email": "octocat@github.com",
33302
+ "name": "Monalisa Octocat"
33303
+ },
33304
+ "message": "commit",
33305
+ "distinct": true,
33306
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
33307
+ }
33308
+ ]
33309
+ },
33310
+ "public": true,
33311
+ "created_at": "2022-06-09T12:47:28Z"
33312
+ },
33313
+ {
33314
+ "id": "22196946742",
33315
+ "type": "CreateEvent",
33316
+ "actor": {
33317
+ "id": 583231,
33318
+ "login": "octocat",
33319
+ "display_login": "octocat",
33320
+ "gravatar_id": "",
33321
+ "url": "https://api.github.com/users/octocat",
33322
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
33323
+ },
33324
+ "repo": {
33325
+ "id": 1296269,
33326
+ "name": "octocat/Hello-World",
33327
+ "url": "https://api.github.com/repos/octocat/Hello-World"
33328
+ },
33329
+ "payload": {
33330
+ "ref": null,
33331
+ "ref_type": "repository",
33332
+ "master_branch": "master",
33333
+ "description": null,
33334
+ "pusher_type": "user"
33335
+ },
33336
+ "public": false,
33337
+ "created_at": "2022-06-07T07:50:26Z",
33338
+ "org": {
33339
+ "id": 9919,
33340
+ "login": "github",
33341
+ "gravatar_id": "",
33342
+ "url": "https://api.github.com/orgs/github",
33343
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
33344
+ }
33345
+ }
33346
+ ]
32832
33347
  }
32833
33348
  },
32834
33349
  "headers": {