@octokit/openapi 6.3.1 → 6.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 (28) hide show
  1. package/generated/api.github.com.deref.json +79 -8
  2. package/generated/api.github.com.json +75 -9
  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 +50 -3
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +53 -3
  7. package/generated/ghes-3.2.deref.json +61 -5
  8. package/generated/ghes-3.2.json +64 -5
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +8 -4
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  12. package/generated/ghes-3.3.deref.json +61 -5
  13. package/generated/ghes-3.3.json +64 -5
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  16. package/generated/ghes-3.4.deref.json +73 -9
  17. package/generated/ghes-3.4.json +68 -9
  18. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +11008 -112568
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +220 -574
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +147 -263
  21. package/generated/ghes-3.5.deref.json +2645 -297
  22. package/generated/ghes-3.5.json +3178 -609
  23. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +41 -3
  24. package/generated/github.ae-diff-to-api.github.com.deref.json +220 -1
  25. package/generated/github.ae-diff-to-api.github.com.json +147 -1
  26. package/generated/github.ae.deref.json +3814 -315
  27. package/generated/github.ae.json +4253 -557
  28. package/package.json +7 -4
@@ -5924,6 +5924,33 @@
5924
5924
  }
5925
5925
  }
5926
5926
  },
5927
+ "/rate_limit": {
5928
+ "get": {
5929
+ "responses": {
5930
+ "changed": {
5931
+ "200": {
5932
+ "content": {
5933
+ "changed": {
5934
+ "application/json": {
5935
+ "schema_changed": {
5936
+ "properties_changed": {
5937
+ "changed": {
5938
+ "resources": {
5939
+ "properties_changed": {
5940
+ "removed": ["dependency_snapshots"]
5941
+ }
5942
+ }
5943
+ }
5944
+ }
5945
+ }
5946
+ }
5947
+ }
5948
+ }
5949
+ }
5950
+ }
5951
+ }
5952
+ }
5953
+ },
5927
5954
  "/repos/{owner}/{repo}": {
5928
5955
  "get": {
5929
5956
  "responses": {
@@ -6691,13 +6718,13 @@
6691
6718
  "style": "form"
6692
6719
  },
6693
6720
  {
6694
- "description": "The property by which to sort the results.",
6721
+ "description": "The property by which to sort the results. `number` is deprecated - we recommend that you use `created` instead.",
6695
6722
  "in": "query",
6696
6723
  "name": "sort",
6697
6724
  "required": false,
6698
6725
  "schema": {
6699
- "default": "number",
6700
- "enum": ["created", "updated", "number"],
6726
+ "default": "created",
6727
+ "enum": ["created", "number", "updated"],
6701
6728
  "type": "string"
6702
6729
  },
6703
6730
  "style": "form"
@@ -7165,6 +7192,17 @@
7165
7192
  }
7166
7193
  },
7167
7194
  "post": {
7195
+ "request_body": {
7196
+ "content_changed": {
7197
+ "changed": {
7198
+ "application/json": {
7199
+ "schema_changed": {
7200
+ "properties_changed": { "removed": ["name"] }
7201
+ }
7202
+ }
7203
+ }
7204
+ }
7205
+ },
7168
7206
  "responses": {
7169
7207
  "changed": {
7170
7208
  "202": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.3.1",
4
+ "version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -32191,6 +32191,225 @@
32191
32191
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
32192
32192
  }
32193
32193
  },
32194
+ "/rate_limit": {
32195
+ "get": {
32196
+ "summary": "Get rate limit status for the authenticated user",
32197
+ "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
32198
+ "tags": ["rate-limit"],
32199
+ "operationId": "rate-limit/get",
32200
+ "externalDocs": {
32201
+ "description": "API method documentation",
32202
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
32203
+ },
32204
+ "parameters": [],
32205
+ "responses": {
32206
+ "200": {
32207
+ "description": "Response",
32208
+ "content": {
32209
+ "application/json": {
32210
+ "schema": {
32211
+ "title": "Rate Limit Overview",
32212
+ "description": "Rate Limit Overview",
32213
+ "type": "object",
32214
+ "properties": {
32215
+ "resources": {
32216
+ "type": "object",
32217
+ "properties": {
32218
+ "core": {
32219
+ "title": "Rate Limit",
32220
+ "type": "object",
32221
+ "properties": {
32222
+ "limit": { "type": "integer" },
32223
+ "remaining": { "type": "integer" },
32224
+ "reset": { "type": "integer" },
32225
+ "used": { "type": "integer" }
32226
+ },
32227
+ "required": ["limit", "remaining", "reset", "used"]
32228
+ },
32229
+ "graphql": {
32230
+ "title": "Rate Limit",
32231
+ "type": "object",
32232
+ "properties": {
32233
+ "limit": { "type": "integer" },
32234
+ "remaining": { "type": "integer" },
32235
+ "reset": { "type": "integer" },
32236
+ "used": { "type": "integer" }
32237
+ },
32238
+ "required": ["limit", "remaining", "reset", "used"]
32239
+ },
32240
+ "search": {
32241
+ "title": "Rate Limit",
32242
+ "type": "object",
32243
+ "properties": {
32244
+ "limit": { "type": "integer" },
32245
+ "remaining": { "type": "integer" },
32246
+ "reset": { "type": "integer" },
32247
+ "used": { "type": "integer" }
32248
+ },
32249
+ "required": ["limit", "remaining", "reset", "used"]
32250
+ },
32251
+ "source_import": {
32252
+ "title": "Rate Limit",
32253
+ "type": "object",
32254
+ "properties": {
32255
+ "limit": { "type": "integer" },
32256
+ "remaining": { "type": "integer" },
32257
+ "reset": { "type": "integer" },
32258
+ "used": { "type": "integer" }
32259
+ },
32260
+ "required": ["limit", "remaining", "reset", "used"]
32261
+ },
32262
+ "integration_manifest": {
32263
+ "title": "Rate Limit",
32264
+ "type": "object",
32265
+ "properties": {
32266
+ "limit": { "type": "integer" },
32267
+ "remaining": { "type": "integer" },
32268
+ "reset": { "type": "integer" },
32269
+ "used": { "type": "integer" }
32270
+ },
32271
+ "required": ["limit", "remaining", "reset", "used"]
32272
+ },
32273
+ "code_scanning_upload": {
32274
+ "title": "Rate Limit",
32275
+ "type": "object",
32276
+ "properties": {
32277
+ "limit": { "type": "integer" },
32278
+ "remaining": { "type": "integer" },
32279
+ "reset": { "type": "integer" },
32280
+ "used": { "type": "integer" }
32281
+ },
32282
+ "required": ["limit", "remaining", "reset", "used"]
32283
+ },
32284
+ "actions_runner_registration": {
32285
+ "title": "Rate Limit",
32286
+ "type": "object",
32287
+ "properties": {
32288
+ "limit": { "type": "integer" },
32289
+ "remaining": { "type": "integer" },
32290
+ "reset": { "type": "integer" },
32291
+ "used": { "type": "integer" }
32292
+ },
32293
+ "required": ["limit", "remaining", "reset", "used"]
32294
+ },
32295
+ "scim": {
32296
+ "title": "Rate Limit",
32297
+ "type": "object",
32298
+ "properties": {
32299
+ "limit": { "type": "integer" },
32300
+ "remaining": { "type": "integer" },
32301
+ "reset": { "type": "integer" },
32302
+ "used": { "type": "integer" }
32303
+ },
32304
+ "required": ["limit", "remaining", "reset", "used"]
32305
+ }
32306
+ },
32307
+ "required": ["core", "search"]
32308
+ },
32309
+ "rate": {
32310
+ "title": "Rate Limit",
32311
+ "type": "object",
32312
+ "properties": {
32313
+ "limit": { "type": "integer" },
32314
+ "remaining": { "type": "integer" },
32315
+ "reset": { "type": "integer" },
32316
+ "used": { "type": "integer" }
32317
+ },
32318
+ "required": ["limit", "remaining", "reset", "used"]
32319
+ }
32320
+ },
32321
+ "required": ["rate", "resources"]
32322
+ },
32323
+ "examples": {
32324
+ "default": {
32325
+ "value": {
32326
+ "resources": {
32327
+ "core": {
32328
+ "limit": 5000,
32329
+ "remaining": 4999,
32330
+ "reset": 1372700873,
32331
+ "used": 1
32332
+ },
32333
+ "search": {
32334
+ "limit": 30,
32335
+ "remaining": 18,
32336
+ "reset": 1372697452,
32337
+ "used": 12
32338
+ },
32339
+ "graphql": {
32340
+ "limit": 5000,
32341
+ "remaining": 4993,
32342
+ "reset": 1372700389,
32343
+ "used": 7
32344
+ },
32345
+ "integration_manifest": {
32346
+ "limit": 5000,
32347
+ "remaining": 4999,
32348
+ "reset": 1551806725,
32349
+ "used": 1
32350
+ },
32351
+ "code_scanning_upload": {
32352
+ "limit": 500,
32353
+ "remaining": 499,
32354
+ "reset": 1551806725,
32355
+ "used": 1
32356
+ }
32357
+ },
32358
+ "rate": {
32359
+ "limit": 5000,
32360
+ "remaining": 4999,
32361
+ "reset": 1372700873,
32362
+ "used": 1
32363
+ }
32364
+ }
32365
+ }
32366
+ }
32367
+ }
32368
+ },
32369
+ "headers": {
32370
+ "X-RateLimit-Limit": {
32371
+ "example": 5000,
32372
+ "schema": { "type": "integer" }
32373
+ },
32374
+ "X-RateLimit-Remaining": {
32375
+ "example": 4999,
32376
+ "schema": { "type": "integer" }
32377
+ },
32378
+ "X-RateLimit-Reset": {
32379
+ "example": 1590701888,
32380
+ "schema": { "type": "integer", "format": "timestamp" }
32381
+ }
32382
+ }
32383
+ },
32384
+ "304": { "description": "Not modified" },
32385
+ "404": {
32386
+ "description": "Resource not found",
32387
+ "content": {
32388
+ "application/json": {
32389
+ "schema": {
32390
+ "title": "Basic Error",
32391
+ "description": "Basic Error",
32392
+ "type": "object",
32393
+ "properties": {
32394
+ "message": { "type": "string" },
32395
+ "documentation_url": { "type": "string" },
32396
+ "url": { "type": "string" },
32397
+ "status": { "type": "string" }
32398
+ }
32399
+ }
32400
+ }
32401
+ }
32402
+ }
32403
+ },
32404
+ "x-github": {
32405
+ "githubCloudOnly": false,
32406
+ "enabledForGitHubApps": true,
32407
+ "category": "rate-limit",
32408
+ "subcategory": null
32409
+ },
32410
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
32411
+ }
32412
+ },
32194
32413
  "/repos/{owner}/{repo}": {
32195
32414
  "get": {
32196
32415
  "summary": "Get a repository",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.3.1",
4
+ "version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -3679,6 +3679,58 @@
3679
3679
  }
3680
3680
  }
3681
3681
  },
3682
+ "/rate_limit": {
3683
+ "get": {
3684
+ "summary": "Get rate limit status for the authenticated user",
3685
+ "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
3686
+ "tags": ["rate-limit"],
3687
+ "operationId": "rate-limit/get",
3688
+ "externalDocs": {
3689
+ "description": "API method documentation",
3690
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
3691
+ },
3692
+ "parameters": [],
3693
+ "responses": {
3694
+ "200": {
3695
+ "description": "Response",
3696
+ "content": {
3697
+ "application/json": {
3698
+ "schema": {
3699
+ "$ref": "#/components/schemas/rate-limit-overview"
3700
+ },
3701
+ "examples": {
3702
+ "default": {
3703
+ "$ref": "#/components/examples/rate-limit-overview"
3704
+ }
3705
+ }
3706
+ }
3707
+ },
3708
+ "headers": {
3709
+ "X-RateLimit-Limit": {
3710
+ "$ref": "#/components/headers/x-rate-limit-limit"
3711
+ },
3712
+ "X-RateLimit-Remaining": {
3713
+ "$ref": "#/components/headers/x-rate-limit-remaining"
3714
+ },
3715
+ "X-RateLimit-Reset": {
3716
+ "$ref": "#/components/headers/x-rate-limit-reset"
3717
+ }
3718
+ }
3719
+ },
3720
+ "304": { "$ref": "#/components/responses/not_modified" },
3721
+ "404": { "$ref": "#/components/responses/not_found" }
3722
+ },
3723
+ "x-github": {
3724
+ "githubCloudOnly": false,
3725
+ "enabledForGitHubApps": true,
3726
+ "category": "rate-limit",
3727
+ "subcategory": null
3728
+ },
3729
+ "x-octokit": {
3730
+ "diff": { "api.github.com.json": { "type": "changed" } }
3731
+ }
3732
+ }
3733
+ },
3682
3734
  "/repos/{owner}/{repo}": {
3683
3735
  "get": {
3684
3736
  "summary": "Get a repository",
@@ -11281,6 +11333,35 @@
11281
11333
  "updated_at"
11282
11334
  ]
11283
11335
  },
11336
+ "rate-limit-overview": {
11337
+ "title": "Rate Limit Overview",
11338
+ "description": "Rate Limit Overview",
11339
+ "type": "object",
11340
+ "properties": {
11341
+ "resources": {
11342
+ "type": "object",
11343
+ "properties": {
11344
+ "core": { "$ref": "#/components/schemas/rate-limit" },
11345
+ "graphql": { "$ref": "#/components/schemas/rate-limit" },
11346
+ "search": { "$ref": "#/components/schemas/rate-limit" },
11347
+ "source_import": { "$ref": "#/components/schemas/rate-limit" },
11348
+ "integration_manifest": {
11349
+ "$ref": "#/components/schemas/rate-limit"
11350
+ },
11351
+ "code_scanning_upload": {
11352
+ "$ref": "#/components/schemas/rate-limit"
11353
+ },
11354
+ "actions_runner_registration": {
11355
+ "$ref": "#/components/schemas/rate-limit"
11356
+ },
11357
+ "scim": { "$ref": "#/components/schemas/rate-limit" }
11358
+ },
11359
+ "required": ["core", "search"]
11360
+ },
11361
+ "rate": { "$ref": "#/components/schemas/rate-limit" }
11362
+ },
11363
+ "required": ["rate", "resources"]
11364
+ },
11284
11365
  "full-repository": {
11285
11366
  "title": "Full Repository",
11286
11367
  "description": "Full Repository",
@@ -14278,6 +14359,17 @@
14278
14359
  },
14279
14360
  "required": ["url", "html_url", "key", "name"]
14280
14361
  },
14362
+ "rate-limit": {
14363
+ "title": "Rate Limit",
14364
+ "type": "object",
14365
+ "properties": {
14366
+ "limit": { "type": "integer" },
14367
+ "remaining": { "type": "integer" },
14368
+ "reset": { "type": "integer" },
14369
+ "used": { "type": "integer" }
14370
+ },
14371
+ "required": ["limit", "remaining", "reset", "used"]
14372
+ },
14281
14373
  "code-of-conduct-simple": {
14282
14374
  "title": "Code Of Conduct Simple",
14283
14375
  "description": "Code of Conduct Simple",
@@ -17732,6 +17824,48 @@
17732
17824
  "watchers": 1
17733
17825
  }
17734
17826
  },
17827
+ "rate-limit-overview": {
17828
+ "value": {
17829
+ "resources": {
17830
+ "core": {
17831
+ "limit": 5000,
17832
+ "remaining": 4999,
17833
+ "reset": 1372700873,
17834
+ "used": 1
17835
+ },
17836
+ "search": {
17837
+ "limit": 30,
17838
+ "remaining": 18,
17839
+ "reset": 1372697452,
17840
+ "used": 12
17841
+ },
17842
+ "graphql": {
17843
+ "limit": 5000,
17844
+ "remaining": 4993,
17845
+ "reset": 1372700389,
17846
+ "used": 7
17847
+ },
17848
+ "integration_manifest": {
17849
+ "limit": 5000,
17850
+ "remaining": 4999,
17851
+ "reset": 1551806725,
17852
+ "used": 1
17853
+ },
17854
+ "code_scanning_upload": {
17855
+ "limit": 500,
17856
+ "remaining": 499,
17857
+ "reset": 1551806725,
17858
+ "used": 1
17859
+ }
17860
+ },
17861
+ "rate": {
17862
+ "limit": 5000,
17863
+ "remaining": 4999,
17864
+ "reset": 1372700873,
17865
+ "used": 1
17866
+ }
17867
+ }
17868
+ },
17735
17869
  "full-repository-default-response": {
17736
17870
  "summary": "Default response",
17737
17871
  "value": {
@@ -24333,6 +24467,18 @@
24333
24467
  "link": {
24334
24468
  "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
24335
24469
  "schema": { "type": "string" }
24470
+ },
24471
+ "x-rate-limit-limit": {
24472
+ "example": 5000,
24473
+ "schema": { "type": "integer" }
24474
+ },
24475
+ "x-rate-limit-remaining": {
24476
+ "example": 4999,
24477
+ "schema": { "type": "integer" }
24478
+ },
24479
+ "x-rate-limit-reset": {
24480
+ "example": 1590701888,
24481
+ "schema": { "type": "integer", "format": "timestamp" }
24336
24482
  }
24337
24483
  },
24338
24484
  "responses": {