@octokit/openapi 6.6.3 → 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.
- package/generated/api.github.com.deref.json +255 -6
- package/generated/api.github.com.json +78 -10
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -1
- package/generated/ghes-3.2.deref.json +1 -1
- package/generated/ghes-3.2.json +1 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
- package/generated/ghes-3.3.deref.json +1 -1
- package/generated/ghes-3.3.json +1 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
- package/generated/ghes-3.4.deref.json +7 -4
- package/generated/ghes-3.4.json +5 -8
- package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +1 -0
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +3 -3
- package/generated/ghes-3.5-diff-to-api.github.com.json +3 -3
- package/generated/ghes-3.5.deref.json +23 -6
- package/generated/ghes-3.5.json +21 -10
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +1 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +1 -1
- package/generated/github.ae-diff-to-api.github.com.json +1 -1
- package/generated/github.ae.deref.json +15 -1
- package/generated/github.ae.json +15 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -21343,7 +21343,7 @@
|
|
|
21343
21343
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
21344
21344
|
"get": {
|
|
21345
21345
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
21346
|
-
"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.",
|
|
21347
21347
|
"tags": ["billing"],
|
|
21348
21348
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
21349
21349
|
"externalDocs": {
|
|
@@ -55382,7 +55382,7 @@
|
|
|
55382
55382
|
"/orgs/{org}/code-scanning/alerts": {
|
|
55383
55383
|
"get": {
|
|
55384
55384
|
"summary": "List code scanning alerts for an organization",
|
|
55385
|
-
"description": "Lists
|
|
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.",
|
|
55386
55386
|
"tags": ["code-scanning"],
|
|
55387
55387
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
55388
55388
|
"externalDocs": {
|
|
@@ -55457,7 +55457,7 @@
|
|
|
55457
55457
|
},
|
|
55458
55458
|
{
|
|
55459
55459
|
"name": "state",
|
|
55460
|
-
"description": "
|
|
55460
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
55461
55461
|
"in": "query",
|
|
55462
55462
|
"required": false,
|
|
55463
55463
|
"schema": {
|
|
@@ -88896,7 +88896,7 @@
|
|
|
88896
88896
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
88897
88897
|
"get": {
|
|
88898
88898
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
88899
|
-
"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.",
|
|
88900
88900
|
"tags": ["billing"],
|
|
88901
88901
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
88902
88902
|
"externalDocs": {
|
|
@@ -174206,6 +174206,252 @@
|
|
|
174206
174206
|
"x-octokit": {}
|
|
174207
174207
|
}
|
|
174208
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
|
+
},
|
|
174209
174455
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
174210
174456
|
"get": {
|
|
174211
174457
|
"summary": "List repository secrets",
|
|
@@ -193317,10 +193563,13 @@
|
|
|
193317
193563
|
"content": {
|
|
193318
193564
|
"application/json": {
|
|
193319
193565
|
"schema": {
|
|
193566
|
+
"title": "Empty Object",
|
|
193567
|
+
"description": "An object without any properties.",
|
|
193320
193568
|
"type": "object",
|
|
193321
193569
|
"properties": {},
|
|
193322
193570
|
"additionalProperties": false
|
|
193323
|
-
}
|
|
193571
|
+
},
|
|
193572
|
+
"examples": { "default": { "value": null } }
|
|
193324
193573
|
}
|
|
193325
193574
|
}
|
|
193326
193575
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -3414,7 +3414,7 @@
|
|
|
3414
3414
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
3415
3415
|
"get": {
|
|
3416
3416
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
3417
|
-
"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.",
|
|
3418
3418
|
"tags": ["billing"],
|
|
3419
3419
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
3420
3420
|
"externalDocs": {
|
|
@@ -8057,7 +8057,7 @@
|
|
|
8057
8057
|
"/orgs/{org}/code-scanning/alerts": {
|
|
8058
8058
|
"get": {
|
|
8059
8059
|
"summary": "List code scanning alerts for an organization",
|
|
8060
|
-
"description": "Lists
|
|
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.",
|
|
8061
8061
|
"tags": ["code-scanning"],
|
|
8062
8062
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
8063
8063
|
"externalDocs": {
|
|
@@ -8075,7 +8075,7 @@
|
|
|
8075
8075
|
{ "$ref": "#/components/parameters/direction" },
|
|
8076
8076
|
{
|
|
8077
8077
|
"name": "state",
|
|
8078
|
-
"description": "
|
|
8078
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
8079
8079
|
"in": "query",
|
|
8080
8080
|
"required": false,
|
|
8081
8081
|
"schema": {
|
|
@@ -11618,7 +11618,7 @@
|
|
|
11618
11618
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
11619
11619
|
"get": {
|
|
11620
11620
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
11621
|
-
"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.",
|
|
11622
11622
|
"tags": ["billing"],
|
|
11623
11623
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
11624
11624
|
"externalDocs": {
|
|
@@ -21947,6 +21947,77 @@
|
|
|
21947
21947
|
"x-octokit": {}
|
|
21948
21948
|
}
|
|
21949
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
|
+
},
|
|
21950
22021
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
21951
22022
|
"get": {
|
|
21952
22023
|
"summary": "List repository secrets",
|
|
@@ -23964,11 +24035,8 @@
|
|
|
23964
24035
|
"description": "Response when creating a secret",
|
|
23965
24036
|
"content": {
|
|
23966
24037
|
"application/json": {
|
|
23967
|
-
"schema": {
|
|
23968
|
-
|
|
23969
|
-
"properties": {},
|
|
23970
|
-
"additionalProperties": false
|
|
23971
|
-
}
|
|
24038
|
+
"schema": { "$ref": "#/components/schemas/empty-object" },
|
|
24039
|
+
"examples": { "default": { "value": null } }
|
|
23972
24040
|
}
|
|
23973
24041
|
}
|
|
23974
24042
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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" },
|
package/generated/ghes-3.2.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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.
|
|
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.
|
|
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.
|
|
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" },
|
package/generated/ghes-3.3.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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.
|
|
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.
|
|
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.
|
|
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" },
|
|
@@ -25947,7 +25947,7 @@
|
|
|
25947
25947
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
25948
25948
|
"get": {
|
|
25949
25949
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
25950
|
-
"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.",
|
|
25950
|
+
"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.",
|
|
25951
25951
|
"tags": ["billing"],
|
|
25952
25952
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
25953
25953
|
"externalDocs": {
|
|
@@ -77276,7 +77276,7 @@
|
|
|
77276
77276
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
77277
77277
|
"get": {
|
|
77278
77278
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
77279
|
-
"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.",
|
|
77279
|
+
"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.",
|
|
77280
77280
|
"tags": ["billing"],
|
|
77281
77281
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
77282
77282
|
"externalDocs": {
|
|
@@ -166737,10 +166737,13 @@
|
|
|
166737
166737
|
"content": {
|
|
166738
166738
|
"application/json": {
|
|
166739
166739
|
"schema": {
|
|
166740
|
+
"title": "Empty Object",
|
|
166741
|
+
"description": "An object without any properties.",
|
|
166740
166742
|
"type": "object",
|
|
166741
166743
|
"properties": {},
|
|
166742
166744
|
"additionalProperties": false
|
|
166743
|
-
}
|
|
166745
|
+
},
|
|
166746
|
+
"examples": { "default": { "value": null } }
|
|
166744
166747
|
}
|
|
166745
166748
|
}
|
|
166746
166749
|
},
|
package/generated/ghes-3.4.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -5304,7 +5304,7 @@
|
|
|
5304
5304
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
5305
5305
|
"get": {
|
|
5306
5306
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
5307
|
-
"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.",
|
|
5307
|
+
"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.",
|
|
5308
5308
|
"tags": ["billing"],
|
|
5309
5309
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
5310
5310
|
"externalDocs": {
|
|
@@ -11708,7 +11708,7 @@
|
|
|
11708
11708
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
11709
11709
|
"get": {
|
|
11710
11710
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
11711
|
-
"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.",
|
|
11711
|
+
"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.",
|
|
11712
11712
|
"tags": ["billing"],
|
|
11713
11713
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
11714
11714
|
"externalDocs": {
|
|
@@ -22281,11 +22281,8 @@
|
|
|
22281
22281
|
"description": "Response when creating a secret",
|
|
22282
22282
|
"content": {
|
|
22283
22283
|
"application/json": {
|
|
22284
|
-
"schema": {
|
|
22285
|
-
|
|
22286
|
-
"properties": {},
|
|
22287
|
-
"additionalProperties": false
|
|
22288
|
-
}
|
|
22284
|
+
"schema": { "$ref": "#/components/schemas/empty-object" },
|
|
22285
|
+
"examples": { "default": { "value": null } }
|
|
22289
22286
|
}
|
|
22290
22287
|
}
|
|
22291
22288
|
},
|
|
@@ -12598,6 +12598,7 @@
|
|
|
12598
12598
|
"/repos/{owner}/{repo}/codespaces": ["get", "post"],
|
|
12599
12599
|
"/repos/{owner}/{repo}/codespaces/devcontainers": ["get"],
|
|
12600
12600
|
"/repos/{owner}/{repo}/codespaces/machines": ["get"],
|
|
12601
|
+
"/repos/{owner}/{repo}/codespaces/new": ["get"],
|
|
12601
12602
|
"/repos/{owner}/{repo}/codespaces/secrets": ["get"],
|
|
12602
12603
|
"/repos/{owner}/{repo}/codespaces/secrets/public-key": ["get"],
|
|
12603
12604
|
"/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": [
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -28967,7 +28967,7 @@
|
|
|
28967
28967
|
"/orgs/{org}/code-scanning/alerts": {
|
|
28968
28968
|
"get": {
|
|
28969
28969
|
"summary": "List code scanning alerts for an organization",
|
|
28970
|
-
"description": "Lists
|
|
28970
|
+
"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/enterprise-server@3.5/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.",
|
|
28971
28971
|
"tags": ["code-scanning"],
|
|
28972
28972
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
28973
28973
|
"externalDocs": {
|
|
@@ -29042,7 +29042,7 @@
|
|
|
29042
29042
|
},
|
|
29043
29043
|
{
|
|
29044
29044
|
"name": "state",
|
|
29045
|
-
"description": "
|
|
29045
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
29046
29046
|
"in": "query",
|
|
29047
29047
|
"required": false,
|
|
29048
29048
|
"schema": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -3589,7 +3589,7 @@
|
|
|
3589
3589
|
"/orgs/{org}/code-scanning/alerts": {
|
|
3590
3590
|
"get": {
|
|
3591
3591
|
"summary": "List code scanning alerts for an organization",
|
|
3592
|
-
"description": "Lists
|
|
3592
|
+
"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/enterprise-server@3.5/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.",
|
|
3593
3593
|
"tags": ["code-scanning"],
|
|
3594
3594
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
3595
3595
|
"externalDocs": {
|
|
@@ -3607,7 +3607,7 @@
|
|
|
3607
3607
|
{ "$ref": "#/components/parameters/direction" },
|
|
3608
3608
|
{
|
|
3609
3609
|
"name": "state",
|
|
3610
|
-
"description": "
|
|
3610
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
3611
3611
|
"in": "query",
|
|
3612
3612
|
"required": false,
|
|
3613
3613
|
"schema": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -26278,7 +26278,7 @@
|
|
|
26278
26278
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
26279
26279
|
"get": {
|
|
26280
26280
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
26281
|
-
"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.",
|
|
26281
|
+
"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.",
|
|
26282
26282
|
"tags": ["billing"],
|
|
26283
26283
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
26284
26284
|
"externalDocs": {
|
|
@@ -57919,7 +57919,7 @@
|
|
|
57919
57919
|
"/orgs/{org}/code-scanning/alerts": {
|
|
57920
57920
|
"get": {
|
|
57921
57921
|
"summary": "List code scanning alerts for an organization",
|
|
57922
|
-
"description": "Lists
|
|
57922
|
+
"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/enterprise-server@3.5/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.",
|
|
57923
57923
|
"tags": ["code-scanning"],
|
|
57924
57924
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
57925
57925
|
"externalDocs": {
|
|
@@ -57994,7 +57994,7 @@
|
|
|
57994
57994
|
},
|
|
57995
57995
|
{
|
|
57996
57996
|
"name": "state",
|
|
57997
|
-
"description": "
|
|
57997
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
57998
57998
|
"in": "query",
|
|
57999
57999
|
"required": false,
|
|
58000
58000
|
"schema": {
|
|
@@ -79176,7 +79176,7 @@
|
|
|
79176
79176
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
79177
79177
|
"get": {
|
|
79178
79178
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
79179
|
-
"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.",
|
|
79179
|
+
"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.",
|
|
79180
79180
|
"tags": ["billing"],
|
|
79181
79181
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
79182
79182
|
"externalDocs": {
|
|
@@ -173735,10 +173735,13 @@
|
|
|
173735
173735
|
"content": {
|
|
173736
173736
|
"application/json": {
|
|
173737
173737
|
"schema": {
|
|
173738
|
+
"title": "Empty Object",
|
|
173739
|
+
"description": "An object without any properties.",
|
|
173738
173740
|
"type": "object",
|
|
173739
173741
|
"properties": {},
|
|
173740
173742
|
"additionalProperties": false
|
|
173741
|
-
}
|
|
173743
|
+
},
|
|
173744
|
+
"examples": { "default": { "value": null } }
|
|
173742
173745
|
}
|
|
173743
173746
|
}
|
|
173744
173747
|
},
|
|
@@ -351635,6 +351638,20 @@
|
|
|
351635
351638
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
351636
351639
|
}
|
|
351637
351640
|
},
|
|
351641
|
+
"/repos/{owner}/{repo}/codespaces/new": {
|
|
351642
|
+
"get": {
|
|
351643
|
+
"summary": "Get default attributes for a codespace",
|
|
351644
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in api.github.com",
|
|
351645
|
+
"tags": ["codespaces"],
|
|
351646
|
+
"operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
|
|
351647
|
+
"externalDocs": {
|
|
351648
|
+
"description": "API method documentation",
|
|
351649
|
+
"url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
|
|
351650
|
+
},
|
|
351651
|
+
"x-octokit": { "api.github.com": "removed" },
|
|
351652
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
351653
|
+
}
|
|
351654
|
+
},
|
|
351638
351655
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
351639
351656
|
"get": {
|
|
351640
351657
|
"summary": "List repository secrets",
|
package/generated/ghes-3.5.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -5442,7 +5442,7 @@
|
|
|
5442
5442
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
5443
5443
|
"get": {
|
|
5444
5444
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
5445
|
-
"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.",
|
|
5445
|
+
"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.",
|
|
5446
5446
|
"tags": ["billing"],
|
|
5447
5447
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
5448
5448
|
"externalDocs": {
|
|
@@ -9518,7 +9518,7 @@
|
|
|
9518
9518
|
"/orgs/{org}/code-scanning/alerts": {
|
|
9519
9519
|
"get": {
|
|
9520
9520
|
"summary": "List code scanning alerts for an organization",
|
|
9521
|
-
"description": "Lists
|
|
9521
|
+
"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/enterprise-server@3.5/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.",
|
|
9522
9522
|
"tags": ["code-scanning"],
|
|
9523
9523
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
9524
9524
|
"externalDocs": {
|
|
@@ -9536,7 +9536,7 @@
|
|
|
9536
9536
|
{ "$ref": "#/components/parameters/direction" },
|
|
9537
9537
|
{
|
|
9538
9538
|
"name": "state",
|
|
9539
|
-
"description": "
|
|
9539
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
9540
9540
|
"in": "query",
|
|
9541
9541
|
"required": false,
|
|
9542
9542
|
"schema": {
|
|
@@ -12115,7 +12115,7 @@
|
|
|
12115
12115
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
12116
12116
|
"get": {
|
|
12117
12117
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
12118
|
-
"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.",
|
|
12118
|
+
"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.",
|
|
12119
12119
|
"tags": ["billing"],
|
|
12120
12120
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
12121
12121
|
"externalDocs": {
|
|
@@ -23118,11 +23118,8 @@
|
|
|
23118
23118
|
"description": "Response when creating a secret",
|
|
23119
23119
|
"content": {
|
|
23120
23120
|
"application/json": {
|
|
23121
|
-
"schema": {
|
|
23122
|
-
|
|
23123
|
-
"properties": {},
|
|
23124
|
-
"additionalProperties": false
|
|
23125
|
-
}
|
|
23121
|
+
"schema": { "$ref": "#/components/schemas/empty-object" },
|
|
23122
|
+
"examples": { "default": { "value": null } }
|
|
23126
23123
|
}
|
|
23127
23124
|
}
|
|
23128
23125
|
},
|
|
@@ -40819,6 +40816,20 @@
|
|
|
40819
40816
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
40820
40817
|
}
|
|
40821
40818
|
},
|
|
40819
|
+
"/repos/{owner}/{repo}/codespaces/new": {
|
|
40820
|
+
"get": {
|
|
40821
|
+
"summary": "Get default attributes for a codespace",
|
|
40822
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in api.github.com",
|
|
40823
|
+
"tags": ["codespaces"],
|
|
40824
|
+
"operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
|
|
40825
|
+
"externalDocs": {
|
|
40826
|
+
"description": "API method documentation",
|
|
40827
|
+
"url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
|
|
40828
|
+
},
|
|
40829
|
+
"x-octokit": { "api.github.com": "removed" },
|
|
40830
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
40831
|
+
}
|
|
40832
|
+
},
|
|
40822
40833
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
40823
40834
|
"get": {
|
|
40824
40835
|
"summary": "List repository secrets",
|
|
@@ -9152,6 +9152,7 @@
|
|
|
9152
9152
|
"/repos/{owner}/{repo}/codespaces": ["get", "post"],
|
|
9153
9153
|
"/repos/{owner}/{repo}/codespaces/devcontainers": ["get"],
|
|
9154
9154
|
"/repos/{owner}/{repo}/codespaces/machines": ["get"],
|
|
9155
|
+
"/repos/{owner}/{repo}/codespaces/new": ["get"],
|
|
9155
9156
|
"/repos/{owner}/{repo}/codespaces/secrets": ["get"],
|
|
9156
9157
|
"/repos/{owner}/{repo}/codespaces/secrets/public-key": ["get"],
|
|
9157
9158
|
"/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": [
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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.
|
|
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.
|
|
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" },
|
|
@@ -310314,6 +310314,20 @@
|
|
|
310314
310314
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
310315
310315
|
}
|
|
310316
310316
|
},
|
|
310317
|
+
"/repos/{owner}/{repo}/codespaces/new": {
|
|
310318
|
+
"get": {
|
|
310319
|
+
"summary": "Get default attributes for a codespace",
|
|
310320
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
310321
|
+
"tags": ["codespaces"],
|
|
310322
|
+
"operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
|
|
310323
|
+
"externalDocs": {
|
|
310324
|
+
"description": "API method documentation",
|
|
310325
|
+
"url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
|
|
310326
|
+
},
|
|
310327
|
+
"x-octokit": { "api.github.com": "removed" },
|
|
310328
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
310329
|
+
}
|
|
310330
|
+
},
|
|
310317
310331
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
310318
310332
|
"get": {
|
|
310319
310333
|
"summary": "List repository secrets",
|
package/generated/github.ae.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -35809,6 +35809,20 @@
|
|
|
35809
35809
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
35810
35810
|
}
|
|
35811
35811
|
},
|
|
35812
|
+
"/repos/{owner}/{repo}/codespaces/new": {
|
|
35813
|
+
"get": {
|
|
35814
|
+
"summary": "Get default attributes for a codespace",
|
|
35815
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
35816
|
+
"tags": ["codespaces"],
|
|
35817
|
+
"operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
|
|
35818
|
+
"externalDocs": {
|
|
35819
|
+
"description": "API method documentation",
|
|
35820
|
+
"url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
|
|
35821
|
+
},
|
|
35822
|
+
"x-octokit": { "api.github.com": "removed" },
|
|
35823
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
35824
|
+
}
|
|
35825
|
+
},
|
|
35812
35826
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
35813
35827
|
"get": {
|
|
35814
35828
|
"summary": "List repository secrets",
|