@octokit/openapi 6.6.1 → 6.7.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": "6.6.1",
4
+ "version": "6.7.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" },
@@ -8594,6 +8594,18 @@
8594
8594
  "type": "string"
8595
8595
  }
8596
8596
  }
8597
+ },
8598
+ "examples": {
8599
+ "default": {
8600
+ "summary": "Create an authorization",
8601
+ "value": {
8602
+ "scopes": ["public_repo"],
8603
+ "note": "optional note",
8604
+ "note_url": "http://optional/note/url",
8605
+ "client_id": "abcde12345fghij67890",
8606
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
8607
+ }
8608
+ }
8597
8609
  }
8598
8610
  }
8599
8611
  }
@@ -9222,9 +9234,9 @@
9222
9234
  "name": "client_id",
9223
9235
  "in": "path",
9224
9236
  "required": true,
9225
- "description": "The client ID of the GitHub app.",
9237
+ "description": "The client ID of the OAuth app.",
9226
9238
  "schema": { "type": "string" },
9227
- "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }
9239
+ "examples": { "default": { "value": "abcde12345fghij67890" } }
9228
9240
  }
9229
9241
  ],
9230
9242
  "requestBody": {
@@ -9261,6 +9273,17 @@
9261
9273
  },
9262
9274
  "required": ["client_secret"],
9263
9275
  "type": "object"
9276
+ },
9277
+ "examples": {
9278
+ "default": {
9279
+ "summary": "Create an authorization for an app",
9280
+ "value": {
9281
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
9282
+ "scopes": ["public_repo"],
9283
+ "note": "optional note",
9284
+ "note_url": "http://optional/note/url"
9285
+ }
9286
+ }
9264
9287
  }
9265
9288
  }
9266
9289
  }
@@ -10369,9 +10392,9 @@
10369
10392
  "name": "client_id",
10370
10393
  "in": "path",
10371
10394
  "required": true,
10372
- "description": "The client ID of the GitHub app.",
10395
+ "description": "The client ID of the OAuth app.",
10373
10396
  "schema": { "type": "string" },
10374
- "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }
10397
+ "examples": { "default": { "value": "abcde12345fghij67890" } }
10375
10398
  },
10376
10399
  {
10377
10400
  "name": "fingerprint",
@@ -10410,6 +10433,17 @@
10410
10433
  },
10411
10434
  "required": ["client_secret"],
10412
10435
  "type": "object"
10436
+ },
10437
+ "examples": {
10438
+ "default": {
10439
+ "summary": "Create an authorization for an app and fingerprint",
10440
+ "value": {
10441
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
10442
+ "scopes": ["public_repo"],
10443
+ "note": "optional note",
10444
+ "note_url": "http://optional/note/url"
10445
+ }
10446
+ }
10413
10447
  }
10414
10448
  }
10415
10449
  }
@@ -21309,7 +21343,7 @@
21309
21343
  "/enterprises/{enterprise}/settings/billing/advanced-security": {
21310
21344
  "get": {
21311
21345
  "summary": "Get GitHub Advanced Security active committers for an enterprise",
21312
- "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.",
21346
+ "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
21313
21347
  "tags": ["billing"],
21314
21348
  "operationId": "billing/get-github-advanced-security-billing-ghe",
21315
21349
  "externalDocs": {
@@ -55348,7 +55382,7 @@
55348
55382
  "/orgs/{org}/code-scanning/alerts": {
55349
55383
  "get": {
55350
55384
  "summary": "List code scanning alerts for an organization",
55351
- "description": "Lists all code scanning alerts for the default branch (usually `main`\nor `master`) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
55385
+ "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
55352
55386
  "tags": ["code-scanning"],
55353
55387
  "operationId": "code-scanning/list-alerts-for-org",
55354
55388
  "externalDocs": {
@@ -55423,7 +55457,7 @@
55423
55457
  },
55424
55458
  {
55425
55459
  "name": "state",
55426
- "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
55460
+ "description": "If specified, only code scanning alerts with this state will be returned.",
55427
55461
  "in": "query",
55428
55462
  "required": false,
55429
55463
  "schema": {
@@ -88862,7 +88896,7 @@
88862
88896
  "/orgs/{org}/settings/billing/advanced-security": {
88863
88897
  "get": {
88864
88898
  "summary": "Get GitHub Advanced Security active committers for an organization",
88865
- "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.",
88899
+ "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
88866
88900
  "tags": ["billing"],
88867
88901
  "operationId": "billing/get-github-advanced-security-billing-org",
88868
88902
  "externalDocs": {
@@ -174172,6 +174206,252 @@
174172
174206
  "x-octokit": {}
174173
174207
  }
174174
174208
  },
174209
+ "/repos/{owner}/{repo}/codespaces/new": {
174210
+ "get": {
174211
+ "summary": "Get default attributes for a codespace",
174212
+ "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
174213
+ "tags": ["codespaces"],
174214
+ "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
174215
+ "externalDocs": {
174216
+ "description": "API method documentation",
174217
+ "url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
174218
+ },
174219
+ "parameters": [
174220
+ {
174221
+ "name": "owner",
174222
+ "description": "The account owner of the repository. The name is not case sensitive.",
174223
+ "in": "path",
174224
+ "required": true,
174225
+ "schema": { "type": "string" }
174226
+ },
174227
+ {
174228
+ "name": "repo",
174229
+ "description": "The name of the repository. The name is not case sensitive.",
174230
+ "in": "path",
174231
+ "required": true,
174232
+ "schema": { "type": "string" }
174233
+ },
174234
+ {
174235
+ "name": "ref",
174236
+ "description": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.",
174237
+ "in": "query",
174238
+ "schema": { "type": "string", "example": "main" }
174239
+ },
174240
+ {
174241
+ "name": "client_ip",
174242
+ "description": "An alternative IP for default location auto-detection, such as when proxying a request.",
174243
+ "in": "query",
174244
+ "schema": { "type": "string", "example": "1.2.3.4" }
174245
+ }
174246
+ ],
174247
+ "responses": {
174248
+ "200": {
174249
+ "description": "Response when a user is able to create codespaces from the repository.",
174250
+ "content": {
174251
+ "application/json": {
174252
+ "schema": {
174253
+ "type": "object",
174254
+ "properties": {
174255
+ "billable_owner": {
174256
+ "title": "Simple User",
174257
+ "description": "Simple User",
174258
+ "type": "object",
174259
+ "properties": {
174260
+ "name": { "nullable": true, "type": "string" },
174261
+ "email": { "nullable": true, "type": "string" },
174262
+ "login": { "type": "string", "example": "octocat" },
174263
+ "id": { "type": "integer", "example": 1 },
174264
+ "node_id": {
174265
+ "type": "string",
174266
+ "example": "MDQ6VXNlcjE="
174267
+ },
174268
+ "avatar_url": {
174269
+ "type": "string",
174270
+ "format": "uri",
174271
+ "example": "https://github.com/images/error/octocat_happy.gif"
174272
+ },
174273
+ "gravatar_id": {
174274
+ "type": "string",
174275
+ "example": "41d064eb2195891e12d0413f63227ea7",
174276
+ "nullable": true
174277
+ },
174278
+ "url": {
174279
+ "type": "string",
174280
+ "format": "uri",
174281
+ "example": "https://api.github.com/users/octocat"
174282
+ },
174283
+ "html_url": {
174284
+ "type": "string",
174285
+ "format": "uri",
174286
+ "example": "https://github.com/octocat"
174287
+ },
174288
+ "followers_url": {
174289
+ "type": "string",
174290
+ "format": "uri",
174291
+ "example": "https://api.github.com/users/octocat/followers"
174292
+ },
174293
+ "following_url": {
174294
+ "type": "string",
174295
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
174296
+ },
174297
+ "gists_url": {
174298
+ "type": "string",
174299
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
174300
+ },
174301
+ "starred_url": {
174302
+ "type": "string",
174303
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
174304
+ },
174305
+ "subscriptions_url": {
174306
+ "type": "string",
174307
+ "format": "uri",
174308
+ "example": "https://api.github.com/users/octocat/subscriptions"
174309
+ },
174310
+ "organizations_url": {
174311
+ "type": "string",
174312
+ "format": "uri",
174313
+ "example": "https://api.github.com/users/octocat/orgs"
174314
+ },
174315
+ "repos_url": {
174316
+ "type": "string",
174317
+ "format": "uri",
174318
+ "example": "https://api.github.com/users/octocat/repos"
174319
+ },
174320
+ "events_url": {
174321
+ "type": "string",
174322
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
174323
+ },
174324
+ "received_events_url": {
174325
+ "type": "string",
174326
+ "format": "uri",
174327
+ "example": "https://api.github.com/users/octocat/received_events"
174328
+ },
174329
+ "type": { "type": "string", "example": "User" },
174330
+ "site_admin": { "type": "boolean" },
174331
+ "starred_at": {
174332
+ "type": "string",
174333
+ "example": "\"2020-07-09T00:17:55Z\""
174334
+ }
174335
+ },
174336
+ "required": [
174337
+ "avatar_url",
174338
+ "events_url",
174339
+ "followers_url",
174340
+ "following_url",
174341
+ "gists_url",
174342
+ "gravatar_id",
174343
+ "html_url",
174344
+ "id",
174345
+ "node_id",
174346
+ "login",
174347
+ "organizations_url",
174348
+ "received_events_url",
174349
+ "repos_url",
174350
+ "site_admin",
174351
+ "starred_url",
174352
+ "subscriptions_url",
174353
+ "type",
174354
+ "url"
174355
+ ]
174356
+ },
174357
+ "defaults": {
174358
+ "type": "object",
174359
+ "required": ["location", "devcontainer_path"],
174360
+ "properties": {
174361
+ "location": { "type": "string" },
174362
+ "devcontainer_path": {
174363
+ "type": "string",
174364
+ "nullable": true
174365
+ }
174366
+ }
174367
+ }
174368
+ }
174369
+ },
174370
+ "examples": {
174371
+ "default": {
174372
+ "value": {
174373
+ "devcontainers": [
174374
+ {
174375
+ "path": ".devcontainer/foobar/devcontainer.json",
174376
+ "name": "foobar"
174377
+ },
174378
+ {
174379
+ "path": ".devcontainer/devcontainer.json",
174380
+ "name": "kitchensink"
174381
+ },
174382
+ { "path": ".devcontainer.json" }
174383
+ ],
174384
+ "total_count": 3
174385
+ }
174386
+ }
174387
+ }
174388
+ }
174389
+ }
174390
+ },
174391
+ "401": {
174392
+ "description": "Requires authentication",
174393
+ "content": {
174394
+ "application/json": {
174395
+ "schema": {
174396
+ "title": "Basic Error",
174397
+ "description": "Basic Error",
174398
+ "type": "object",
174399
+ "properties": {
174400
+ "message": { "type": "string" },
174401
+ "documentation_url": { "type": "string" },
174402
+ "url": { "type": "string" },
174403
+ "status": { "type": "string" }
174404
+ }
174405
+ }
174406
+ }
174407
+ }
174408
+ },
174409
+ "403": {
174410
+ "description": "Forbidden",
174411
+ "content": {
174412
+ "application/json": {
174413
+ "schema": {
174414
+ "title": "Basic Error",
174415
+ "description": "Basic Error",
174416
+ "type": "object",
174417
+ "properties": {
174418
+ "message": { "type": "string" },
174419
+ "documentation_url": { "type": "string" },
174420
+ "url": { "type": "string" },
174421
+ "status": { "type": "string" }
174422
+ }
174423
+ }
174424
+ }
174425
+ }
174426
+ },
174427
+ "404": {
174428
+ "description": "Resource not found",
174429
+ "content": {
174430
+ "application/json": {
174431
+ "schema": {
174432
+ "title": "Basic Error",
174433
+ "description": "Basic Error",
174434
+ "type": "object",
174435
+ "properties": {
174436
+ "message": { "type": "string" },
174437
+ "documentation_url": { "type": "string" },
174438
+ "url": { "type": "string" },
174439
+ "status": { "type": "string" }
174440
+ }
174441
+ }
174442
+ }
174443
+ }
174444
+ }
174445
+ },
174446
+ "x-github": {
174447
+ "githubCloudOnly": false,
174448
+ "enabledForGitHubApps": true,
174449
+ "category": "codespaces",
174450
+ "subcategory": null
174451
+ },
174452
+ "x-octokit": {}
174453
+ }
174454
+ },
174175
174455
  "/repos/{owner}/{repo}/codespaces/secrets": {
174176
174456
  "get": {
174177
174457
  "summary": "List repository secrets",
@@ -193283,10 +193563,13 @@
193283
193563
  "content": {
193284
193564
  "application/json": {
193285
193565
  "schema": {
193566
+ "title": "Empty Object",
193567
+ "description": "An object without any properties.",
193286
193568
  "type": "object",
193287
193569
  "properties": {},
193288
193570
  "additionalProperties": false
193289
- }
193571
+ },
193572
+ "examples": { "default": { "value": null } }
193290
193573
  }
193291
193574
  }
193292
193575
  },
@@ -288348,7 +288631,7 @@
288348
288631
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
288349
288632
  "get": {
288350
288633
  "summary": "List requested reviewers for a pull request",
288351
- "description": "",
288634
+ "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
288352
288635
  "tags": ["pulls"],
288353
288636
  "operationId": "pulls/list-requested-reviewers",
288354
288637
  "externalDocs": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.6.1",
4
+ "version": "6.7.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" },
@@ -1239,6 +1239,18 @@
1239
1239
  "type": "string"
1240
1240
  }
1241
1241
  }
1242
+ },
1243
+ "examples": {
1244
+ "default": {
1245
+ "summary": "Create an authorization",
1246
+ "value": {
1247
+ "scopes": ["public_repo"],
1248
+ "note": "optional note",
1249
+ "note_url": "http://optional/note/url",
1250
+ "client_id": "abcde12345fghij67890",
1251
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
1252
+ }
1253
+ }
1242
1254
  }
1243
1255
  }
1244
1256
  }
@@ -1289,7 +1301,7 @@
1289
1301
  "description": "API method documentation",
1290
1302
  "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
1291
1303
  },
1292
- "parameters": [{ "$ref": "#/components/parameters/client-id" }],
1304
+ "parameters": [{ "$ref": "#/components/parameters/oauth-client-id" }],
1293
1305
  "requestBody": {
1294
1306
  "required": true,
1295
1307
  "content": {
@@ -1324,6 +1336,17 @@
1324
1336
  },
1325
1337
  "required": ["client_secret"],
1326
1338
  "type": "object"
1339
+ },
1340
+ "examples": {
1341
+ "default": {
1342
+ "summary": "Create an authorization for an app",
1343
+ "value": {
1344
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
1345
+ "scopes": ["public_repo"],
1346
+ "note": "optional note",
1347
+ "note_url": "http://optional/note/url"
1348
+ }
1349
+ }
1327
1350
  }
1328
1351
  }
1329
1352
  }
@@ -1393,7 +1416,7 @@
1393
1416
  "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
1394
1417
  },
1395
1418
  "parameters": [
1396
- { "$ref": "#/components/parameters/client-id" },
1419
+ { "$ref": "#/components/parameters/oauth-client-id" },
1397
1420
  {
1398
1421
  "name": "fingerprint",
1399
1422
  "in": "path",
@@ -1431,6 +1454,17 @@
1431
1454
  },
1432
1455
  "required": ["client_secret"],
1433
1456
  "type": "object"
1457
+ },
1458
+ "examples": {
1459
+ "default": {
1460
+ "summary": "Create an authorization for an app and fingerprint",
1461
+ "value": {
1462
+ "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
1463
+ "scopes": ["public_repo"],
1464
+ "note": "optional note",
1465
+ "note_url": "http://optional/note/url"
1466
+ }
1467
+ }
1434
1468
  }
1435
1469
  }
1436
1470
  }
@@ -3380,7 +3414,7 @@
3380
3414
  "/enterprises/{enterprise}/settings/billing/advanced-security": {
3381
3415
  "get": {
3382
3416
  "summary": "Get GitHub Advanced Security active committers for an enterprise",
3383
- "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.",
3417
+ "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
3384
3418
  "tags": ["billing"],
3385
3419
  "operationId": "billing/get-github-advanced-security-billing-ghe",
3386
3420
  "externalDocs": {
@@ -8023,7 +8057,7 @@
8023
8057
  "/orgs/{org}/code-scanning/alerts": {
8024
8058
  "get": {
8025
8059
  "summary": "List code scanning alerts for an organization",
8026
- "description": "Lists all code scanning alerts for the default branch (usually `main`\nor `master`) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
8060
+ "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
8027
8061
  "tags": ["code-scanning"],
8028
8062
  "operationId": "code-scanning/list-alerts-for-org",
8029
8063
  "externalDocs": {
@@ -8041,7 +8075,7 @@
8041
8075
  { "$ref": "#/components/parameters/direction" },
8042
8076
  {
8043
8077
  "name": "state",
8044
- "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
8078
+ "description": "If specified, only code scanning alerts with this state will be returned.",
8045
8079
  "in": "query",
8046
8080
  "required": false,
8047
8081
  "schema": {
@@ -11584,7 +11618,7 @@
11584
11618
  "/orgs/{org}/settings/billing/advanced-security": {
11585
11619
  "get": {
11586
11620
  "summary": "Get GitHub Advanced Security active committers for an organization",
11587
- "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.",
11621
+ "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
11588
11622
  "tags": ["billing"],
11589
11623
  "operationId": "billing/get-github-advanced-security-billing-org",
11590
11624
  "externalDocs": {
@@ -21913,6 +21947,77 @@
21913
21947
  "x-octokit": {}
21914
21948
  }
21915
21949
  },
21950
+ "/repos/{owner}/{repo}/codespaces/new": {
21951
+ "get": {
21952
+ "summary": "Get default attributes for a codespace",
21953
+ "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
21954
+ "tags": ["codespaces"],
21955
+ "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
21956
+ "externalDocs": {
21957
+ "description": "API method documentation",
21958
+ "url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
21959
+ },
21960
+ "parameters": [
21961
+ { "$ref": "#/components/parameters/owner" },
21962
+ { "$ref": "#/components/parameters/repo" },
21963
+ {
21964
+ "name": "ref",
21965
+ "description": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.",
21966
+ "in": "query",
21967
+ "schema": { "type": "string", "example": "main" }
21968
+ },
21969
+ {
21970
+ "name": "client_ip",
21971
+ "description": "An alternative IP for default location auto-detection, such as when proxying a request.",
21972
+ "in": "query",
21973
+ "schema": { "type": "string", "example": "1.2.3.4" }
21974
+ }
21975
+ ],
21976
+ "responses": {
21977
+ "200": {
21978
+ "description": "Response when a user is able to create codespaces from the repository.",
21979
+ "content": {
21980
+ "application/json": {
21981
+ "schema": {
21982
+ "type": "object",
21983
+ "properties": {
21984
+ "billable_owner": {
21985
+ "$ref": "#/components/schemas/simple-user"
21986
+ },
21987
+ "defaults": {
21988
+ "type": "object",
21989
+ "required": ["location", "devcontainer_path"],
21990
+ "properties": {
21991
+ "location": { "type": "string" },
21992
+ "devcontainer_path": {
21993
+ "type": "string",
21994
+ "nullable": true
21995
+ }
21996
+ }
21997
+ }
21998
+ }
21999
+ },
22000
+ "examples": {
22001
+ "default": {
22002
+ "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository"
22003
+ }
22004
+ }
22005
+ }
22006
+ }
22007
+ },
22008
+ "401": { "$ref": "#/components/responses/requires_authentication" },
22009
+ "403": { "$ref": "#/components/responses/forbidden" },
22010
+ "404": { "$ref": "#/components/responses/not_found" }
22011
+ },
22012
+ "x-github": {
22013
+ "githubCloudOnly": false,
22014
+ "enabledForGitHubApps": true,
22015
+ "category": "codespaces",
22016
+ "subcategory": null
22017
+ },
22018
+ "x-octokit": {}
22019
+ }
22020
+ },
21916
22021
  "/repos/{owner}/{repo}/codespaces/secrets": {
21917
22022
  "get": {
21918
22023
  "summary": "List repository secrets",
@@ -23930,11 +24035,8 @@
23930
24035
  "description": "Response when creating a secret",
23931
24036
  "content": {
23932
24037
  "application/json": {
23933
- "schema": {
23934
- "type": "object",
23935
- "properties": {},
23936
- "additionalProperties": false
23937
- }
24038
+ "schema": { "$ref": "#/components/schemas/empty-object" },
24039
+ "examples": { "default": { "value": null } }
23938
24040
  }
23939
24041
  }
23940
24042
  },
@@ -31785,7 +31887,7 @@
31785
31887
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
31786
31888
  "get": {
31787
31889
  "summary": "List requested reviewers for a pull request",
31788
- "description": "",
31890
+ "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
31789
31891
  "tags": ["pulls"],
31790
31892
  "operationId": "pulls/list-requested-reviewers",
31791
31893
  "externalDocs": {
@@ -86328,6 +86430,14 @@
86328
86430
  "required": true,
86329
86431
  "schema": { "type": "string" }
86330
86432
  },
86433
+ "oauth-client-id": {
86434
+ "name": "client_id",
86435
+ "in": "path",
86436
+ "required": true,
86437
+ "description": "The client ID of the OAuth app.",
86438
+ "schema": { "type": "string" },
86439
+ "examples": { "default": { "value": "abcde12345fghij67890" } }
86440
+ },
86331
86441
  "authorization-id": {
86332
86442
  "name": "authorization_id",
86333
86443
  "description": "The unique identifier of the authorization.",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.6.1",
4
+ "version": "6.7.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.6.1",
4
+ "version": "6.7.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" },