@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" },
@@ -1397,7 +1397,7 @@
1397
1397
  "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#update-a-webhook-configuration-for-an-app"
1398
1398
  },
1399
1399
  "requestBody": {
1400
- "required": false,
1400
+ "required": true,
1401
1401
  "content": {
1402
1402
  "application/json": {
1403
1403
  "schema": {
@@ -5138,7 +5138,7 @@
5138
5138
  "type": "object",
5139
5139
  "properties": {
5140
5140
  "last_read_at": {
5141
- "description": "Describes the last point that notifications were checked.",
5141
+ "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.",
5142
5142
  "type": "string",
5143
5143
  "format": "date-time"
5144
5144
  },
@@ -5147,6 +5147,14 @@
5147
5147
  "type": "boolean"
5148
5148
  }
5149
5149
  }
5150
+ },
5151
+ "examples": {
5152
+ "default": {
5153
+ "value": {
5154
+ "last_read_at": "2022-06-10T00:00:00Z",
5155
+ "read": true
5156
+ }
5157
+ }
5150
5158
  }
5151
5159
  }
5152
5160
  }
@@ -5159,6 +5167,11 @@
5159
5167
  "schema": {
5160
5168
  "type": "object",
5161
5169
  "properties": { "message": { "type": "string" } }
5170
+ },
5171
+ "examples": {
5172
+ "default": {
5173
+ "$ref": "#/components/examples/notifications-mark-read"
5174
+ }
5162
5175
  }
5163
5176
  }
5164
5177
  }
@@ -5300,7 +5313,8 @@
5300
5313
  }
5301
5314
  },
5302
5315
  "type": "object"
5303
- }
5316
+ },
5317
+ "examples": { "default": { "value": { "ignored": false } } }
5304
5318
  }
5305
5319
  }
5306
5320
  },
@@ -30581,6 +30595,12 @@
30581
30595
  "default": "member"
30582
30596
  }
30583
30597
  }
30598
+ },
30599
+ "examples": {
30600
+ "default": {
30601
+ "summary": "Assign the member role for a user in a team",
30602
+ "value": { "role": "member" }
30603
+ }
30584
30604
  }
30585
30605
  }
30586
30606
  }
@@ -33276,6 +33296,11 @@
33276
33296
  "schema": {
33277
33297
  "type": "array",
33278
33298
  "items": { "$ref": "#/components/schemas/event" }
33299
+ },
33300
+ "examples": {
33301
+ "default": {
33302
+ "$ref": "#/components/examples/user-events-items"
33303
+ }
33279
33304
  }
33280
33305
  }
33281
33306
  }
@@ -33316,6 +33341,11 @@
33316
33341
  "schema": {
33317
33342
  "type": "array",
33318
33343
  "items": { "$ref": "#/components/schemas/event" }
33344
+ },
33345
+ "examples": {
33346
+ "default": {
33347
+ "$ref": "#/components/examples/user-org-events-items"
33348
+ }
33319
33349
  }
33320
33350
  }
33321
33351
  }
@@ -35987,6 +36017,20 @@
35987
36017
  "responses": { "501": { "description": "Not Implemented" } }
35988
36018
  }
35989
36019
  },
36020
+ "/repos/{owner}/{repo}/dependency-graph/snapshots": {
36021
+ "post": {
36022
+ "summary": "Create a snapshot of dependencies for a repository",
36023
+ "description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
36024
+ "tags": ["dependency-graph"],
36025
+ "operationId": "dependency-graph/create-repository-snapshot",
36026
+ "externalDocs": {
36027
+ "description": "API method documentation",
36028
+ "url": "https://docs.github.com/rest/reference/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository"
36029
+ },
36030
+ "x-octokit": { "api.github.com.json": "removed" },
36031
+ "responses": { "501": { "description": "Not Implemented" } }
36032
+ }
36033
+ },
35990
36034
  "/repos/{owner}/{repo}/import": {
35991
36035
  "get": {
35992
36036
  "summary": "Get an import status",
@@ -56556,6 +56600,11 @@
56556
56600
  }
56557
56601
  ]
56558
56602
  },
56603
+ "notifications-mark-read": {
56604
+ "value": {
56605
+ "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background."
56606
+ }
56607
+ },
56559
56608
  "thread": {
56560
56609
  "value": {
56561
56610
  "id": "1",
@@ -71240,6 +71289,145 @@
71240
71289
  }
71241
71290
  }
71242
71291
  },
71292
+ "user-events-items": {
71293
+ "value": [
71294
+ {
71295
+ "id": "22249084947",
71296
+ "type": "WatchEvent",
71297
+ "actor": {
71298
+ "id": 583231,
71299
+ "login": "octocat",
71300
+ "display_login": "octocat",
71301
+ "gravatar_id": "",
71302
+ "url": "https://api.github.com/users/octocat",
71303
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
71304
+ },
71305
+ "repo": {
71306
+ "id": 1296269,
71307
+ "name": "octocat/Hello-World",
71308
+ "url": "https://api.github.com/repos/octocat/Hello-World"
71309
+ },
71310
+ "payload": { "action": "started" },
71311
+ "public": true,
71312
+ "created_at": "2022-06-09T12:47:28Z"
71313
+ },
71314
+ {
71315
+ "id": "22249084964",
71316
+ "type": "PushEvent",
71317
+ "actor": {
71318
+ "id": 583231,
71319
+ "login": "octocat",
71320
+ "display_login": "octocat",
71321
+ "gravatar_id": "",
71322
+ "url": "https://api.github.com/users/octocat",
71323
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
71324
+ },
71325
+ "repo": {
71326
+ "id": 1296269,
71327
+ "name": "octocat/Hello-World",
71328
+ "url": "https://api.github.com/repos/octocat/Hello-World"
71329
+ },
71330
+ "payload": {
71331
+ "push_id": 10115855396,
71332
+ "size": 1,
71333
+ "distinct_size": 1,
71334
+ "ref": "refs/heads/master",
71335
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
71336
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
71337
+ "commits": [
71338
+ {
71339
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
71340
+ "author": {
71341
+ "email": "octocat@github.com",
71342
+ "name": "Monalisa Octocat"
71343
+ },
71344
+ "message": "commit",
71345
+ "distinct": true,
71346
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
71347
+ }
71348
+ ]
71349
+ },
71350
+ "public": false,
71351
+ "created_at": "2022-06-07T07:50:26Z"
71352
+ }
71353
+ ]
71354
+ },
71355
+ "user-org-events-items": {
71356
+ "value": [
71357
+ {
71358
+ "id": "22249084964",
71359
+ "type": "PushEvent",
71360
+ "actor": {
71361
+ "id": 583231,
71362
+ "login": "octocat",
71363
+ "display_login": "octocat",
71364
+ "gravatar_id": "",
71365
+ "url": "https://api.github.com/users/octocat",
71366
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
71367
+ },
71368
+ "repo": {
71369
+ "id": 1296269,
71370
+ "name": "octocat/Hello-World",
71371
+ "url": "https://api.github.com/repos/octocat/Hello-World"
71372
+ },
71373
+ "payload": {
71374
+ "push_id": 10115855396,
71375
+ "size": 1,
71376
+ "distinct_size": 1,
71377
+ "ref": "refs/heads/master",
71378
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
71379
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
71380
+ "commits": [
71381
+ {
71382
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
71383
+ "author": {
71384
+ "email": "octocat@github.com",
71385
+ "name": "Monalisa Octocat"
71386
+ },
71387
+ "message": "commit",
71388
+ "distinct": true,
71389
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
71390
+ }
71391
+ ]
71392
+ },
71393
+ "public": false,
71394
+ "created_at": "2022-06-09T12:47:28Z"
71395
+ },
71396
+ {
71397
+ "id": "22196946742",
71398
+ "type": "CreateEvent",
71399
+ "actor": {
71400
+ "id": 583231,
71401
+ "login": "octocat",
71402
+ "display_login": "octocat",
71403
+ "gravatar_id": "",
71404
+ "url": "https://api.github.com/users/octocat",
71405
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
71406
+ },
71407
+ "repo": {
71408
+ "id": 1296269,
71409
+ "name": "octocat/Hello-World",
71410
+ "url": "https://api.github.com/repos/octocat/Hello-World"
71411
+ },
71412
+ "payload": {
71413
+ "ref": null,
71414
+ "ref_type": "repository",
71415
+ "master_branch": "master",
71416
+ "description": null,
71417
+ "pusher_type": "user"
71418
+ },
71419
+ "public": false,
71420
+ "created_at": "2022-06-07T07:50:26Z",
71421
+ "org": {
71422
+ "id": 9919,
71423
+ "login": "github",
71424
+ "gravatar_id": "",
71425
+ "url": "https://api.github.com/orgs/github",
71426
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
71427
+ }
71428
+ }
71429
+ ]
71430
+ },
71243
71431
  "hovercard": {
71244
71432
  "value": {
71245
71433
  "contexts": [{ "message": "Owns this repository", "octicon": "repo" }]
@@ -71499,7 +71687,7 @@
71499
71687
  },
71500
71688
  "thread-id": {
71501
71689
  "name": "thread_id",
71502
- "description": "The unique identifier of the thread.",
71690
+ "description": "The unique identifier of the pull request thread.",
71503
71691
  "in": "path",
71504
71692
  "required": true,
71505
71693
  "schema": { "type": "integer" }
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "5.12.0",
6
+ "version": "5.13.0",
7
7
  "description": "GitHub's official OpenAPI spec with Octokit extensions",
8
8
  "main": "index.js",
9
9
  "files": [