@octokit/openapi 6.1.2 → 6.2.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 (28) hide show
  1. package/generated/api.github.com.deref.json +19628 -17725
  2. package/generated/api.github.com.json +1 -1
  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 +1 -1
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -1
  7. package/generated/ghes-3.2.deref.json +173 -3
  8. package/generated/ghes-3.2.json +163 -4
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +354 -1388
  12. package/generated/ghes-3.3.json +461 -287
  13. package/generated/ghes-3.4-anicca-diff-to-ghes-3.5.deref.json +0 -14
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +7801 -10209
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +341 -326
  16. package/generated/ghes-3.4.deref.json +1408 -3641
  17. package/generated/ghes-3.4.json +1145 -968
  18. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +10 -72
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +29452 -32935
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +442 -569
  21. package/generated/ghes-3.5.deref.json +1663 -4953
  22. package/generated/ghes-3.5.json +1301 -1254
  23. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +10 -0
  24. package/generated/github.ae-diff-to-api.github.com.deref.json +66 -1
  25. package/generated/github.ae-diff-to-api.github.com.json +69 -1
  26. package/generated/github.ae.deref.json +234 -2
  27. package/generated/github.ae.json +221 -3
  28. package/package.json +3 -3
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -53889,7 +53889,8 @@
53889
53889
  "type": "object",
53890
53890
  "properties": {},
53891
53891
  "additionalProperties": false
53892
- }
53892
+ },
53893
+ "examples": { "default": { "value": null } }
53893
53894
  }
53894
53895
  }
53895
53896
  },
@@ -58112,6 +58113,71 @@
58112
58113
  "created_at"
58113
58114
  ]
58114
58115
  }
58116
+ },
58117
+ "examples": {
58118
+ "200-response": {
58119
+ "value": [
58120
+ {
58121
+ "id": "22237752260",
58122
+ "type": "WatchEvent",
58123
+ "actor": {
58124
+ "id": 583231,
58125
+ "login": "octocat",
58126
+ "display_login": "octocat",
58127
+ "gravatar_id": "",
58128
+ "url": "https://api.github.com/users/octocat",
58129
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58130
+ },
58131
+ "repo": {
58132
+ "id": 1296269,
58133
+ "name": "octo-org/octo-repo",
58134
+ "url": "https://api.github.com/repos/octo-org/octo-repo"
58135
+ },
58136
+ "payload": { "action": "started" },
58137
+ "public": true,
58138
+ "created_at": "2022-06-08T23:29:25Z"
58139
+ },
58140
+ {
58141
+ "id": "22249084964",
58142
+ "type": "PushEvent",
58143
+ "actor": {
58144
+ "id": 583231,
58145
+ "login": "octocat",
58146
+ "display_login": "octocat",
58147
+ "gravatar_id": "",
58148
+ "url": "https://api.github.com/users/octocat",
58149
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58150
+ },
58151
+ "repo": {
58152
+ "id": 1296269,
58153
+ "name": "octo-org/octo-repo",
58154
+ "url": "https://api.github.com/repos/octo-org/oct-repo"
58155
+ },
58156
+ "payload": {
58157
+ "push_id": 10115855396,
58158
+ "size": 1,
58159
+ "distinct_size": 1,
58160
+ "ref": "refs/heads/master",
58161
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58162
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
58163
+ "commits": [
58164
+ {
58165
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58166
+ "author": {
58167
+ "email": "octocat@github.com",
58168
+ "name": "Monalisa Octocat"
58169
+ },
58170
+ "message": "commit",
58171
+ "distinct": true,
58172
+ "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
58173
+ }
58174
+ ]
58175
+ },
58176
+ "public": true,
58177
+ "created_at": "2022-06-09T12:47:28Z"
58178
+ }
58179
+ ]
58180
+ }
58115
58181
  }
58116
58182
  }
58117
58183
  }
@@ -93069,6 +93135,24 @@
93069
93135
  "schema": { "type": "string" }
93070
93136
  }
93071
93137
  }
93138
+ },
93139
+ "410": {
93140
+ "description": "Gone",
93141
+ "content": {
93142
+ "application/json": {
93143
+ "schema": {
93144
+ "title": "Basic Error",
93145
+ "description": "Basic Error",
93146
+ "type": "object",
93147
+ "properties": {
93148
+ "message": { "type": "string" },
93149
+ "documentation_url": { "type": "string" },
93150
+ "url": { "type": "string" },
93151
+ "status": { "type": "string" }
93152
+ }
93153
+ }
93154
+ }
93155
+ }
93072
93156
  }
93073
93157
  },
93074
93158
  "x-github": {
@@ -162031,6 +162115,71 @@
162031
162115
  "created_at"
162032
162116
  ]
162033
162117
  }
162118
+ },
162119
+ "examples": {
162120
+ "200-response": {
162121
+ "value": [
162122
+ {
162123
+ "id": "22249084964",
162124
+ "type": "PushEvent",
162125
+ "actor": {
162126
+ "id": 583231,
162127
+ "login": "octocat",
162128
+ "display_login": "octocat",
162129
+ "gravatar_id": "",
162130
+ "url": "https://api.github.com/users/octocat",
162131
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
162132
+ },
162133
+ "repo": {
162134
+ "id": 1296269,
162135
+ "name": "octocat/Hello-World",
162136
+ "url": "https://api.github.com/repos/octocat/Hello-World"
162137
+ },
162138
+ "payload": {
162139
+ "push_id": 10115855396,
162140
+ "size": 1,
162141
+ "distinct_size": 1,
162142
+ "ref": "refs/heads/master",
162143
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
162144
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
162145
+ "commits": [
162146
+ {
162147
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
162148
+ "author": {
162149
+ "email": "octocat@github.com",
162150
+ "name": "Monalisa Octocat"
162151
+ },
162152
+ "message": "commit",
162153
+ "distinct": true,
162154
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
162155
+ }
162156
+ ]
162157
+ },
162158
+ "public": true,
162159
+ "created_at": "2022-06-09T12:47:28Z"
162160
+ },
162161
+ {
162162
+ "id": "22237752260",
162163
+ "type": "WatchEvent",
162164
+ "actor": {
162165
+ "id": 583231,
162166
+ "login": "octocat",
162167
+ "display_login": "octocat",
162168
+ "gravatar_id": "",
162169
+ "url": "https://api.github.com/users/octocat",
162170
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
162171
+ },
162172
+ "repo": {
162173
+ "id": 1296269,
162174
+ "name": "octocat/Hello-World",
162175
+ "url": "https://api.github.com/repos/octocat/Hello-World"
162176
+ },
162177
+ "payload": { "action": "started" },
162178
+ "public": true,
162179
+ "created_at": "2022-06-08T23:29:25Z"
162180
+ }
162181
+ ]
162182
+ }
162034
162183
  }
162035
162184
  }
162036
162185
  }
@@ -266178,7 +266327,8 @@
266178
266327
  "type": "object",
266179
266328
  "properties": {},
266180
266329
  "additionalProperties": false
266181
- }
266330
+ },
266331
+ "examples": { "default": { "value": null } }
266182
266332
  }
266183
266333
  }
266184
266334
  },
@@ -285939,6 +286089,18 @@
285939
286089
  }
285940
286090
  }
285941
286091
  ]
286092
+ },
286093
+ "examples": {
286094
+ "default": {
286095
+ "summary": "Example adding multiple email addresses",
286096
+ "value": {
286097
+ "emails": [
286098
+ "octocat@github.com",
286099
+ "mona@github.com",
286100
+ "octocat@octocat.org"
286101
+ ]
286102
+ }
286103
+ }
285942
286104
  }
285943
286105
  }
285944
286106
  }
@@ -286147,6 +286309,14 @@
286147
286309
  "required": ["emails"]
286148
286310
  }
286149
286311
  ]
286312
+ },
286313
+ "examples": {
286314
+ "default": {
286315
+ "summary": "Example deleting multiple email accounts",
286316
+ "value": {
286317
+ "emails": ["octocat@github.com", "mona@github.com"]
286318
+ }
286319
+ }
286150
286320
  }
286151
286321
  }
286152
286322
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -8652,7 +8652,8 @@
8652
8652
  "description": "Response when creating a secret",
8653
8653
  "content": {
8654
8654
  "application/json": {
8655
- "schema": { "$ref": "#/components/schemas/empty-object" }
8655
+ "schema": { "$ref": "#/components/schemas/empty-object" },
8656
+ "examples": { "default": { "value": null } }
8656
8657
  }
8657
8658
  }
8658
8659
  },
@@ -8881,6 +8882,11 @@
8881
8882
  "schema": {
8882
8883
  "type": "array",
8883
8884
  "items": { "$ref": "#/components/schemas/event" }
8885
+ },
8886
+ "examples": {
8887
+ "200-response": {
8888
+ "$ref": "#/components/examples/public-org-events-items"
8889
+ }
8884
8890
  }
8885
8891
  }
8886
8892
  }
@@ -14275,7 +14281,8 @@
14275
14281
  "headers": {
14276
14282
  "Location": { "$ref": "#/components/headers/location" }
14277
14283
  }
14278
- }
14284
+ },
14285
+ "410": { "$ref": "#/components/responses/gone" }
14279
14286
  },
14280
14287
  "x-github": {
14281
14288
  "githubCloudOnly": false,
@@ -21897,6 +21904,11 @@
21897
21904
  "schema": {
21898
21905
  "type": "array",
21899
21906
  "items": { "$ref": "#/components/schemas/event" }
21907
+ },
21908
+ "examples": {
21909
+ "200-response": {
21910
+ "$ref": "#/components/examples/repo-events-items"
21911
+ }
21900
21912
  }
21901
21913
  }
21902
21914
  }
@@ -31416,7 +31428,8 @@
31416
31428
  "description": "Response when creating a secret",
31417
31429
  "content": {
31418
31430
  "application/json": {
31419
- "schema": { "$ref": "#/components/schemas/empty-object" }
31431
+ "schema": { "$ref": "#/components/schemas/empty-object" },
31432
+ "examples": { "default": { "value": null } }
31420
31433
  }
31421
31434
  }
31422
31435
  },
@@ -34512,6 +34525,18 @@
34512
34525
  }
34513
34526
  }
34514
34527
  ]
34528
+ },
34529
+ "examples": {
34530
+ "default": {
34531
+ "summary": "Example adding multiple email addresses",
34532
+ "value": {
34533
+ "emails": [
34534
+ "octocat@github.com",
34535
+ "mona@github.com",
34536
+ "octocat@octocat.org"
34537
+ ]
34538
+ }
34539
+ }
34515
34540
  }
34516
34541
  }
34517
34542
  }
@@ -34588,6 +34613,14 @@
34588
34613
  "required": ["emails"]
34589
34614
  }
34590
34615
  ]
34616
+ },
34617
+ "examples": {
34618
+ "default": {
34619
+ "summary": "Example deleting multiple email accounts",
34620
+ "value": {
34621
+ "emails": ["octocat@github.com", "mona@github.com"]
34622
+ }
34623
+ }
34591
34624
  }
34592
34625
  }
34593
34626
  }
@@ -58137,6 +58170,69 @@
58137
58170
  ]
58138
58171
  }
58139
58172
  },
58173
+ "public-org-events-items": {
58174
+ "value": [
58175
+ {
58176
+ "id": "22237752260",
58177
+ "type": "WatchEvent",
58178
+ "actor": {
58179
+ "id": 583231,
58180
+ "login": "octocat",
58181
+ "display_login": "octocat",
58182
+ "gravatar_id": "",
58183
+ "url": "https://api.github.com/users/octocat",
58184
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58185
+ },
58186
+ "repo": {
58187
+ "id": 1296269,
58188
+ "name": "octo-org/octo-repo",
58189
+ "url": "https://api.github.com/repos/octo-org/octo-repo"
58190
+ },
58191
+ "payload": { "action": "started" },
58192
+ "public": true,
58193
+ "created_at": "2022-06-08T23:29:25Z"
58194
+ },
58195
+ {
58196
+ "id": "22249084964",
58197
+ "type": "PushEvent",
58198
+ "actor": {
58199
+ "id": 583231,
58200
+ "login": "octocat",
58201
+ "display_login": "octocat",
58202
+ "gravatar_id": "",
58203
+ "url": "https://api.github.com/users/octocat",
58204
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58205
+ },
58206
+ "repo": {
58207
+ "id": 1296269,
58208
+ "name": "octo-org/octo-repo",
58209
+ "url": "https://api.github.com/repos/octo-org/oct-repo"
58210
+ },
58211
+ "payload": {
58212
+ "push_id": 10115855396,
58213
+ "size": 1,
58214
+ "distinct_size": 1,
58215
+ "ref": "refs/heads/master",
58216
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58217
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
58218
+ "commits": [
58219
+ {
58220
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58221
+ "author": {
58222
+ "email": "octocat@github.com",
58223
+ "name": "Monalisa Octocat"
58224
+ },
58225
+ "message": "commit",
58226
+ "distinct": true,
58227
+ "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
58228
+ }
58229
+ ]
58230
+ },
58231
+ "public": true,
58232
+ "created_at": "2022-06-09T12:47:28Z"
58233
+ }
58234
+ ]
58235
+ },
58140
58236
  "org-hook-items": {
58141
58237
  "value": [
58142
58238
  {
@@ -65769,6 +65865,69 @@
65769
65865
  }
65770
65866
  }
65771
65867
  },
65868
+ "repo-events-items": {
65869
+ "value": [
65870
+ {
65871
+ "id": "22249084964",
65872
+ "type": "PushEvent",
65873
+ "actor": {
65874
+ "id": 583231,
65875
+ "login": "octocat",
65876
+ "display_login": "octocat",
65877
+ "gravatar_id": "",
65878
+ "url": "https://api.github.com/users/octocat",
65879
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
65880
+ },
65881
+ "repo": {
65882
+ "id": 1296269,
65883
+ "name": "octocat/Hello-World",
65884
+ "url": "https://api.github.com/repos/octocat/Hello-World"
65885
+ },
65886
+ "payload": {
65887
+ "push_id": 10115855396,
65888
+ "size": 1,
65889
+ "distinct_size": 1,
65890
+ "ref": "refs/heads/master",
65891
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
65892
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
65893
+ "commits": [
65894
+ {
65895
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
65896
+ "author": {
65897
+ "email": "octocat@github.com",
65898
+ "name": "Monalisa Octocat"
65899
+ },
65900
+ "message": "commit",
65901
+ "distinct": true,
65902
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
65903
+ }
65904
+ ]
65905
+ },
65906
+ "public": true,
65907
+ "created_at": "2022-06-09T12:47:28Z"
65908
+ },
65909
+ {
65910
+ "id": "22237752260",
65911
+ "type": "WatchEvent",
65912
+ "actor": {
65913
+ "id": 583231,
65914
+ "login": "octocat",
65915
+ "display_login": "octocat",
65916
+ "gravatar_id": "",
65917
+ "url": "https://api.github.com/users/octocat",
65918
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
65919
+ },
65920
+ "repo": {
65921
+ "id": 1296269,
65922
+ "name": "octocat/Hello-World",
65923
+ "url": "https://api.github.com/repos/octocat/Hello-World"
65924
+ },
65925
+ "payload": { "action": "started" },
65926
+ "public": true,
65927
+ "created_at": "2022-06-08T23:29:25Z"
65928
+ }
65929
+ ]
65930
+ },
65772
65931
  "minimal-repository-items-2": {
65773
65932
  "value": [
65774
65933
  {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.2",
4
+ "version": "6.2.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" },