@octokit/openapi 14.1.0 → 15.1.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 +216 -40
- package/generated/api.github.com.json +125 -48
- package/generated/ghec.deref.json +238 -52
- package/generated/ghec.json +147 -60
- package/generated/ghes-3.10.deref.json +85 -22
- package/generated/ghes-3.10.json +49 -22
- package/generated/ghes-3.11.deref.json +96 -31
- package/generated/ghes-3.11.json +62 -44
- package/generated/ghes-3.12.deref.json +96 -31
- package/generated/ghes-3.12.json +62 -44
- package/generated/ghes-3.8.deref.json +85 -22
- package/generated/ghes-3.8.json +49 -22
- package/generated/ghes-3.9.deref.json +85 -22
- package/generated/ghes-3.9.json +49 -22
- package/generated/github.ae.deref.json +1 -1
- package/generated/github.ae.json +1 -1
- package/package.json +3 -2
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "15.1.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": {
|
|
@@ -253,7 +253,8 @@
|
|
|
253
253
|
},
|
|
254
254
|
"hub_url": {
|
|
255
255
|
"type": "string",
|
|
256
|
-
"format": "uri-template"
|
|
256
|
+
"format": "uri-template",
|
|
257
|
+
"deprecated": true
|
|
257
258
|
},
|
|
258
259
|
"issue_search_url": {
|
|
259
260
|
"type": "string",
|
|
@@ -349,7 +350,6 @@
|
|
|
349
350
|
"followers_url",
|
|
350
351
|
"following_url",
|
|
351
352
|
"gists_url",
|
|
352
|
-
"hub_url",
|
|
353
353
|
"issue_search_url",
|
|
354
354
|
"issues_url",
|
|
355
355
|
"keys_url",
|
|
@@ -476,19 +476,21 @@
|
|
|
476
476
|
"description": "If specified, only advisories for these ecosystems will be returned.",
|
|
477
477
|
"schema": {
|
|
478
478
|
"type": "string",
|
|
479
|
+
"description": "The package's language or package management ecosystem.",
|
|
479
480
|
"enum": [
|
|
480
|
-
"
|
|
481
|
-
"composer",
|
|
482
|
-
"erlang",
|
|
483
|
-
"go",
|
|
484
|
-
"maven",
|
|
481
|
+
"rubygems",
|
|
485
482
|
"npm",
|
|
486
|
-
"nuget",
|
|
487
|
-
"other",
|
|
488
483
|
"pip",
|
|
484
|
+
"maven",
|
|
485
|
+
"nuget",
|
|
486
|
+
"composer",
|
|
487
|
+
"go",
|
|
488
|
+
"rust",
|
|
489
|
+
"erlang",
|
|
490
|
+
"actions",
|
|
489
491
|
"pub",
|
|
490
|
-
"
|
|
491
|
-
"
|
|
492
|
+
"other",
|
|
493
|
+
"swift"
|
|
492
494
|
]
|
|
493
495
|
}
|
|
494
496
|
},
|
|
@@ -23551,6 +23553,11 @@
|
|
|
23551
23553
|
"example": false,
|
|
23552
23554
|
"description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise."
|
|
23553
23555
|
},
|
|
23556
|
+
"advanced_security_enabled_for_new_user_namespace_repositories": {
|
|
23557
|
+
"type": "boolean",
|
|
23558
|
+
"example": false,
|
|
23559
|
+
"description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories."
|
|
23560
|
+
},
|
|
23554
23561
|
"dependabot_alerts_enabled_for_new_repositories": {
|
|
23555
23562
|
"type": "boolean",
|
|
23556
23563
|
"example": false,
|
|
@@ -23668,6 +23675,10 @@
|
|
|
23668
23675
|
"type": "boolean",
|
|
23669
23676
|
"description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\""
|
|
23670
23677
|
},
|
|
23678
|
+
"advanced_security_enabled_new_user_namespace_repos": {
|
|
23679
|
+
"type": "boolean",
|
|
23680
|
+
"description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\""
|
|
23681
|
+
},
|
|
23671
23682
|
"dependabot_alerts_enabled_for_new_repositories": {
|
|
23672
23683
|
"type": "boolean",
|
|
23673
23684
|
"description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\""
|
|
@@ -27367,6 +27378,7 @@
|
|
|
27367
27378
|
"type": "string",
|
|
27368
27379
|
"enum": [
|
|
27369
27380
|
"advanced_security",
|
|
27381
|
+
"advanced_security_user_namespace",
|
|
27370
27382
|
"dependabot_alerts",
|
|
27371
27383
|
"secret_scanning",
|
|
27372
27384
|
"secret_scanning_push_protection"
|
|
@@ -84106,7 +84118,7 @@
|
|
|
84106
84118
|
"/orgs/{org}/hooks": {
|
|
84107
84119
|
"get": {
|
|
84108
84120
|
"summary": "List organization webhooks",
|
|
84109
|
-
"description": "",
|
|
84121
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
84110
84122
|
"tags": [
|
|
84111
84123
|
"orgs"
|
|
84112
84124
|
],
|
|
@@ -84315,7 +84327,7 @@
|
|
|
84315
84327
|
},
|
|
84316
84328
|
"post": {
|
|
84317
84329
|
"summary": "Create an organization webhook",
|
|
84318
|
-
"description": "
|
|
84330
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
84319
84331
|
"tags": [
|
|
84320
84332
|
"orgs"
|
|
84321
84333
|
],
|
|
@@ -84668,7 +84680,7 @@
|
|
|
84668
84680
|
"/orgs/{org}/hooks/{hook_id}": {
|
|
84669
84681
|
"get": {
|
|
84670
84682
|
"summary": "Get an organization webhook",
|
|
84671
|
-
"description": "
|
|
84683
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
84672
84684
|
"tags": [
|
|
84673
84685
|
"orgs"
|
|
84674
84686
|
],
|
|
@@ -84855,7 +84867,7 @@
|
|
|
84855
84867
|
},
|
|
84856
84868
|
"patch": {
|
|
84857
84869
|
"summary": "Update an organization webhook",
|
|
84858
|
-
"description": "
|
|
84870
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
84859
84871
|
"tags": [
|
|
84860
84872
|
"orgs"
|
|
84861
84873
|
],
|
|
@@ -85188,7 +85200,7 @@
|
|
|
85188
85200
|
},
|
|
85189
85201
|
"delete": {
|
|
85190
85202
|
"summary": "Delete an organization webhook",
|
|
85191
|
-
"description": "",
|
|
85203
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
85192
85204
|
"tags": [
|
|
85193
85205
|
"orgs"
|
|
85194
85206
|
],
|
|
@@ -85260,7 +85272,7 @@
|
|
|
85260
85272
|
"/orgs/{org}/hooks/{hook_id}/config": {
|
|
85261
85273
|
"get": {
|
|
85262
85274
|
"summary": "Get a webhook configuration for an organization",
|
|
85263
|
-
"description": "
|
|
85275
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
85264
85276
|
"tags": [
|
|
85265
85277
|
"orgs"
|
|
85266
85278
|
],
|
|
@@ -85353,7 +85365,7 @@
|
|
|
85353
85365
|
},
|
|
85354
85366
|
"patch": {
|
|
85355
85367
|
"summary": "Update a webhook configuration for an organization",
|
|
85356
|
-
"description": "
|
|
85368
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
85357
85369
|
"tags": [
|
|
85358
85370
|
"orgs"
|
|
85359
85371
|
],
|
|
@@ -85499,7 +85511,7 @@
|
|
|
85499
85511
|
"/orgs/{org}/hooks/{hook_id}/deliveries": {
|
|
85500
85512
|
"get": {
|
|
85501
85513
|
"summary": "List deliveries for an organization webhook",
|
|
85502
|
-
"description": "
|
|
85514
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
85503
85515
|
"tags": [
|
|
85504
85516
|
"orgs"
|
|
85505
85517
|
],
|
|
@@ -85818,7 +85830,7 @@
|
|
|
85818
85830
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
|
|
85819
85831
|
"get": {
|
|
85820
85832
|
"summary": "Get a webhook delivery for an organization webhook",
|
|
85821
|
-
"description": "
|
|
85833
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
85822
85834
|
"tags": [
|
|
85823
85835
|
"orgs"
|
|
85824
85836
|
],
|
|
@@ -86180,7 +86192,7 @@
|
|
|
86180
86192
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
|
|
86181
86193
|
"post": {
|
|
86182
86194
|
"summary": "Redeliver a delivery for an organization webhook",
|
|
86183
|
-
"description": "
|
|
86195
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
86184
86196
|
"tags": [
|
|
86185
86197
|
"orgs"
|
|
86186
86198
|
],
|
|
@@ -86375,7 +86387,7 @@
|
|
|
86375
86387
|
"/orgs/{org}/hooks/{hook_id}/pings": {
|
|
86376
86388
|
"post": {
|
|
86377
86389
|
"summary": "Ping an organization webhook",
|
|
86378
|
-
"description": "
|
|
86390
|
+
"description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
86379
86391
|
"tags": [
|
|
86380
86392
|
"orgs"
|
|
86381
86393
|
],
|
|
@@ -163230,7 +163242,7 @@
|
|
|
163230
163242
|
"/repos/{owner}/{repo}/actions/runs": {
|
|
163231
163243
|
"get": {
|
|
163232
163244
|
"summary": "List workflow runs for a repository",
|
|
163233
|
-
"description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository
|
|
163245
|
+
"description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.",
|
|
163234
163246
|
"tags": [
|
|
163235
163247
|
"actions"
|
|
163236
163248
|
],
|
|
@@ -248601,6 +248613,32 @@
|
|
|
248601
248613
|
"204": {
|
|
248602
248614
|
"description": "Response"
|
|
248603
248615
|
},
|
|
248616
|
+
"404": {
|
|
248617
|
+
"description": "Resource not found",
|
|
248618
|
+
"content": {
|
|
248619
|
+
"application/json": {
|
|
248620
|
+
"schema": {
|
|
248621
|
+
"title": "Basic Error",
|
|
248622
|
+
"description": "Basic Error",
|
|
248623
|
+
"type": "object",
|
|
248624
|
+
"properties": {
|
|
248625
|
+
"message": {
|
|
248626
|
+
"type": "string"
|
|
248627
|
+
},
|
|
248628
|
+
"documentation_url": {
|
|
248629
|
+
"type": "string"
|
|
248630
|
+
},
|
|
248631
|
+
"url": {
|
|
248632
|
+
"type": "string"
|
|
248633
|
+
},
|
|
248634
|
+
"status": {
|
|
248635
|
+
"type": "string"
|
|
248636
|
+
}
|
|
248637
|
+
}
|
|
248638
|
+
}
|
|
248639
|
+
}
|
|
248640
|
+
}
|
|
248641
|
+
},
|
|
248604
248642
|
"422": {
|
|
248605
248643
|
"description": "Validation failed, or the endpoint has been spammed.",
|
|
248606
248644
|
"content": {
|
|
@@ -343892,6 +343930,32 @@
|
|
|
343892
343930
|
}
|
|
343893
343931
|
}
|
|
343894
343932
|
},
|
|
343933
|
+
"406": {
|
|
343934
|
+
"description": "Unacceptable",
|
|
343935
|
+
"content": {
|
|
343936
|
+
"application/json": {
|
|
343937
|
+
"schema": {
|
|
343938
|
+
"title": "Basic Error",
|
|
343939
|
+
"description": "Basic Error",
|
|
343940
|
+
"type": "object",
|
|
343941
|
+
"properties": {
|
|
343942
|
+
"message": {
|
|
343943
|
+
"type": "string"
|
|
343944
|
+
},
|
|
343945
|
+
"documentation_url": {
|
|
343946
|
+
"type": "string"
|
|
343947
|
+
},
|
|
343948
|
+
"url": {
|
|
343949
|
+
"type": "string"
|
|
343950
|
+
},
|
|
343951
|
+
"status": {
|
|
343952
|
+
"type": "string"
|
|
343953
|
+
}
|
|
343954
|
+
}
|
|
343955
|
+
}
|
|
343956
|
+
}
|
|
343957
|
+
}
|
|
343958
|
+
},
|
|
343895
343959
|
"500": {
|
|
343896
343960
|
"description": "Internal Error",
|
|
343897
343961
|
"content": {
|
|
@@ -382088,6 +382152,7 @@
|
|
|
382088
382152
|
"type": "string",
|
|
382089
382153
|
"enum": [
|
|
382090
382154
|
"commit",
|
|
382155
|
+
"wiki_commit",
|
|
382091
382156
|
"issue_title",
|
|
382092
382157
|
"issue_body",
|
|
382093
382158
|
"issue_comment",
|
|
@@ -382161,6 +382226,64 @@
|
|
|
382161
382226
|
"commit_url"
|
|
382162
382227
|
]
|
|
382163
382228
|
},
|
|
382229
|
+
{
|
|
382230
|
+
"description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.",
|
|
382231
|
+
"type": "object",
|
|
382232
|
+
"properties": {
|
|
382233
|
+
"path": {
|
|
382234
|
+
"type": "string",
|
|
382235
|
+
"description": "The file path of the wiki page",
|
|
382236
|
+
"example": "/example/Home.md"
|
|
382237
|
+
},
|
|
382238
|
+
"start_line": {
|
|
382239
|
+
"type": "number",
|
|
382240
|
+
"description": "Line number at which the secret starts in the file"
|
|
382241
|
+
},
|
|
382242
|
+
"end_line": {
|
|
382243
|
+
"type": "number",
|
|
382244
|
+
"description": "Line number at which the secret ends in the file"
|
|
382245
|
+
},
|
|
382246
|
+
"start_column": {
|
|
382247
|
+
"type": "number",
|
|
382248
|
+
"description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."
|
|
382249
|
+
},
|
|
382250
|
+
"end_column": {
|
|
382251
|
+
"type": "number",
|
|
382252
|
+
"description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."
|
|
382253
|
+
},
|
|
382254
|
+
"blob_sha": {
|
|
382255
|
+
"type": "string",
|
|
382256
|
+
"description": "SHA-1 hash ID of the associated blob",
|
|
382257
|
+
"example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
|
|
382258
|
+
},
|
|
382259
|
+
"page_url": {
|
|
382260
|
+
"type": "string",
|
|
382261
|
+
"description": "The GitHub URL to get the associated wiki page",
|
|
382262
|
+
"example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
382263
|
+
},
|
|
382264
|
+
"commit_sha": {
|
|
382265
|
+
"type": "string",
|
|
382266
|
+
"description": "SHA-1 hash ID of the associated commit",
|
|
382267
|
+
"example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
382268
|
+
},
|
|
382269
|
+
"commit_url": {
|
|
382270
|
+
"type": "string",
|
|
382271
|
+
"description": "The GitHub URL to get the associated wiki commit",
|
|
382272
|
+
"example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
382273
|
+
}
|
|
382274
|
+
},
|
|
382275
|
+
"required": [
|
|
382276
|
+
"path",
|
|
382277
|
+
"start_line",
|
|
382278
|
+
"end_line",
|
|
382279
|
+
"start_column",
|
|
382280
|
+
"end_column",
|
|
382281
|
+
"blob_sha",
|
|
382282
|
+
"page_url",
|
|
382283
|
+
"commit_sha",
|
|
382284
|
+
"commit_url"
|
|
382285
|
+
]
|
|
382286
|
+
},
|
|
382164
382287
|
{
|
|
382165
382288
|
"description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
|
|
382166
382289
|
"type": "object",
|
|
@@ -382328,11 +382451,7 @@
|
|
|
382328
382451
|
}
|
|
382329
382452
|
]
|
|
382330
382453
|
}
|
|
382331
|
-
}
|
|
382332
|
-
"required": [
|
|
382333
|
-
"type",
|
|
382334
|
-
"details"
|
|
382335
|
-
]
|
|
382454
|
+
}
|
|
382336
382455
|
}
|
|
382337
382456
|
},
|
|
382338
382457
|
"examples": {
|
|
@@ -382352,6 +382471,20 @@
|
|
|
382352
382471
|
"commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
|
|
382353
382472
|
}
|
|
382354
382473
|
},
|
|
382474
|
+
{
|
|
382475
|
+
"type": "wiki_commit",
|
|
382476
|
+
"details": {
|
|
382477
|
+
"path": "/example/Home.md",
|
|
382478
|
+
"start_line": 1,
|
|
382479
|
+
"end_line": 1,
|
|
382480
|
+
"start_column": 1,
|
|
382481
|
+
"end_column": 64,
|
|
382482
|
+
"blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
|
|
382483
|
+
"page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
382484
|
+
"commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
382485
|
+
"commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
382486
|
+
}
|
|
382487
|
+
},
|
|
382355
382488
|
{
|
|
382356
382489
|
"type": "issue_title",
|
|
382357
382490
|
"details": {
|
|
@@ -406568,7 +406701,7 @@
|
|
|
406568
406701
|
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
406569
406702
|
"get": {
|
|
406570
406703
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
406571
|
-
"description": "**Note:**
|
|
406704
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
|
|
406572
406705
|
"operationId": "enterprise-admin/list-provisioned-groups-enterprise",
|
|
406573
406706
|
"tags": [
|
|
406574
406707
|
"enterprise-admin",
|
|
@@ -407104,7 +407237,7 @@
|
|
|
407104
407237
|
},
|
|
407105
407238
|
"post": {
|
|
407106
407239
|
"summary": "Provision a SCIM enterprise group",
|
|
407107
|
-
"description": "**Note:**
|
|
407240
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.",
|
|
407108
407241
|
"operationId": "enterprise-admin/provision-enterprise-group",
|
|
407109
407242
|
"tags": [
|
|
407110
407243
|
"enterprise-admin"
|
|
@@ -407614,7 +407747,7 @@
|
|
|
407614
407747
|
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
407615
407748
|
"get": {
|
|
407616
407749
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
407617
|
-
"description": "**Note:**
|
|
407750
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM group.",
|
|
407618
407751
|
"operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group",
|
|
407619
407752
|
"tags": [
|
|
407620
407753
|
"enterprise-admin"
|
|
@@ -408090,7 +408223,7 @@
|
|
|
408090
408223
|
},
|
|
408091
408224
|
"put": {
|
|
408092
408225
|
"summary": "Set SCIM information for a provisioned enterprise group",
|
|
408093
|
-
"description": "**Note:**
|
|
408226
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.",
|
|
408094
408227
|
"operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group",
|
|
408095
408228
|
"tags": [
|
|
408096
408229
|
"enterprise-admin"
|
|
@@ -408683,7 +408816,7 @@
|
|
|
408683
408816
|
},
|
|
408684
408817
|
"patch": {
|
|
408685
408818
|
"summary": "Update an attribute for a SCIM enterprise group",
|
|
408686
|
-
"description": "**Note:**
|
|
408819
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n**Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here.",
|
|
408687
408820
|
"operationId": "enterprise-admin/update-attribute-for-enterprise-group",
|
|
408688
408821
|
"tags": [
|
|
408689
408822
|
"enterprise-admin"
|
|
@@ -409274,7 +409407,7 @@
|
|
|
409274
409407
|
},
|
|
409275
409408
|
"delete": {
|
|
409276
409409
|
"summary": "Delete a SCIM group from an enterprise",
|
|
409277
|
-
"description": "**Note:**
|
|
409410
|
+
"description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nDeletes a SCIM group from an enterprise.",
|
|
409278
409411
|
"operationId": "enterprise-admin/delete-scim-group-from-enterprise",
|
|
409279
409412
|
"tags": [
|
|
409280
409413
|
"enterprise-admin"
|
|
@@ -409572,7 +409705,7 @@
|
|
|
409572
409705
|
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
409573
409706
|
"get": {
|
|
409574
409707
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
409575
|
-
"description": "**Note:**
|
|
409708
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.",
|
|
409576
409709
|
"operationId": "enterprise-admin/list-provisioned-identities-enterprise",
|
|
409577
409710
|
"tags": [
|
|
409578
409711
|
"enterprise-admin"
|
|
@@ -410169,7 +410302,7 @@
|
|
|
410169
410302
|
},
|
|
410170
410303
|
"post": {
|
|
410171
410304
|
"summary": "Provision a SCIM enterprise user",
|
|
410172
|
-
"description": "**Note:**
|
|
410305
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.",
|
|
410173
410306
|
"operationId": "enterprise-admin/provision-enterprise-user",
|
|
410174
410307
|
"tags": [
|
|
410175
410308
|
"enterprise-admin"
|
|
@@ -410934,7 +411067,7 @@
|
|
|
410934
411067
|
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
410935
411068
|
"get": {
|
|
410936
411069
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
410937
|
-
"description": "**Note:**
|
|
411070
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM user.",
|
|
410938
411071
|
"operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user",
|
|
410939
411072
|
"tags": [
|
|
410940
411073
|
"enterprise-admin"
|
|
@@ -411477,7 +411610,7 @@
|
|
|
411477
411610
|
},
|
|
411478
411611
|
"put": {
|
|
411479
411612
|
"summary": "Set SCIM information for a provisioned enterprise user",
|
|
411480
|
-
"description": "**Note:**
|
|
411613
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.",
|
|
411481
411614
|
"operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user",
|
|
411482
411615
|
"tags": [
|
|
411483
411616
|
"enterprise-admin"
|
|
@@ -412207,7 +412340,7 @@
|
|
|
412207
412340
|
},
|
|
412208
412341
|
"patch": {
|
|
412209
412342
|
"summary": "Update an attribute for a SCIM enterprise user",
|
|
412210
|
-
"description": "**Note:**
|
|
412343
|
+
"description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```",
|
|
412211
412344
|
"operationId": "enterprise-admin/update-attribute-for-enterprise-user",
|
|
412212
412345
|
"tags": [
|
|
412213
412346
|
"enterprise-admin"
|
|
@@ -412936,7 +413069,7 @@
|
|
|
412936
413069
|
},
|
|
412937
413070
|
"delete": {
|
|
412938
413071
|
"summary": "Delete a SCIM user from an enterprise",
|
|
412939
|
-
"description": "**Note:**
|
|
413072
|
+
"description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.",
|
|
412940
413073
|
"operationId": "enterprise-admin/delete-user-from-enterprise",
|
|
412941
413074
|
"tags": [
|
|
412942
413075
|
"enterprise-admin"
|
|
@@ -990317,8 +990450,7 @@
|
|
|
990317
990450
|
},
|
|
990318
990451
|
"repository-dispatch-sample.collected": {
|
|
990319
990452
|
"post": {
|
|
990320
|
-
"summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
|
|
990321
|
-
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
|
|
990453
|
+
"summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
|
|
990322
990454
|
"operationId": "repository-dispatch/sample.collected",
|
|
990323
990455
|
"externalDocs": {
|
|
990324
990456
|
"url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch"
|
|
@@ -990391,9 +990523,7 @@
|
|
|
990391
990523
|
"properties": {
|
|
990392
990524
|
"action": {
|
|
990393
990525
|
"type": "string",
|
|
990394
|
-
"
|
|
990395
|
-
"sample.collected"
|
|
990396
|
-
]
|
|
990526
|
+
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
990397
990527
|
},
|
|
990398
990528
|
"branch": {
|
|
990399
990529
|
"type": "string"
|
|
@@ -990401,7 +990531,8 @@
|
|
|
990401
990531
|
"client_payload": {
|
|
990402
990532
|
"type": "object",
|
|
990403
990533
|
"nullable": true,
|
|
990404
|
-
"additionalProperties": true
|
|
990534
|
+
"additionalProperties": true,
|
|
990535
|
+
"description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
990405
990536
|
},
|
|
990406
990537
|
"enterprise": {
|
|
990407
990538
|
"title": "Enterprise",
|
|
@@ -1022469,6 +1022600,7 @@
|
|
|
1022469
1022600
|
"type": "string",
|
|
1022470
1022601
|
"enum": [
|
|
1022471
1022602
|
"commit",
|
|
1022603
|
+
"wiki_commit",
|
|
1022472
1022604
|
"issue_title",
|
|
1022473
1022605
|
"issue_body",
|
|
1022474
1022606
|
"issue_comment",
|
|
@@ -1022542,6 +1022674,64 @@
|
|
|
1022542
1022674
|
"commit_url"
|
|
1022543
1022675
|
]
|
|
1022544
1022676
|
},
|
|
1022677
|
+
{
|
|
1022678
|
+
"description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.",
|
|
1022679
|
+
"type": "object",
|
|
1022680
|
+
"properties": {
|
|
1022681
|
+
"path": {
|
|
1022682
|
+
"type": "string",
|
|
1022683
|
+
"description": "The file path of the wiki page",
|
|
1022684
|
+
"example": "/example/Home.md"
|
|
1022685
|
+
},
|
|
1022686
|
+
"start_line": {
|
|
1022687
|
+
"type": "number",
|
|
1022688
|
+
"description": "Line number at which the secret starts in the file"
|
|
1022689
|
+
},
|
|
1022690
|
+
"end_line": {
|
|
1022691
|
+
"type": "number",
|
|
1022692
|
+
"description": "Line number at which the secret ends in the file"
|
|
1022693
|
+
},
|
|
1022694
|
+
"start_column": {
|
|
1022695
|
+
"type": "number",
|
|
1022696
|
+
"description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."
|
|
1022697
|
+
},
|
|
1022698
|
+
"end_column": {
|
|
1022699
|
+
"type": "number",
|
|
1022700
|
+
"description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."
|
|
1022701
|
+
},
|
|
1022702
|
+
"blob_sha": {
|
|
1022703
|
+
"type": "string",
|
|
1022704
|
+
"description": "SHA-1 hash ID of the associated blob",
|
|
1022705
|
+
"example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
|
|
1022706
|
+
},
|
|
1022707
|
+
"page_url": {
|
|
1022708
|
+
"type": "string",
|
|
1022709
|
+
"description": "The GitHub URL to get the associated wiki page",
|
|
1022710
|
+
"example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
1022711
|
+
},
|
|
1022712
|
+
"commit_sha": {
|
|
1022713
|
+
"type": "string",
|
|
1022714
|
+
"description": "SHA-1 hash ID of the associated commit",
|
|
1022715
|
+
"example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
1022716
|
+
},
|
|
1022717
|
+
"commit_url": {
|
|
1022718
|
+
"type": "string",
|
|
1022719
|
+
"description": "The GitHub URL to get the associated wiki commit",
|
|
1022720
|
+
"example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
1022721
|
+
}
|
|
1022722
|
+
},
|
|
1022723
|
+
"required": [
|
|
1022724
|
+
"path",
|
|
1022725
|
+
"start_line",
|
|
1022726
|
+
"end_line",
|
|
1022727
|
+
"start_column",
|
|
1022728
|
+
"end_column",
|
|
1022729
|
+
"blob_sha",
|
|
1022730
|
+
"page_url",
|
|
1022731
|
+
"commit_sha",
|
|
1022732
|
+
"commit_url"
|
|
1022733
|
+
]
|
|
1022734
|
+
},
|
|
1022545
1022735
|
{
|
|
1022546
1022736
|
"description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
|
|
1022547
1022737
|
"type": "object",
|
|
@@ -1022709,11 +1022899,7 @@
|
|
|
1022709
1022899
|
}
|
|
1022710
1022900
|
]
|
|
1022711
1022901
|
}
|
|
1022712
|
-
}
|
|
1022713
|
-
"required": [
|
|
1022714
|
-
"type",
|
|
1022715
|
-
"details"
|
|
1022716
|
-
]
|
|
1022902
|
+
}
|
|
1022717
1022903
|
},
|
|
1022718
1022904
|
"organization": {
|
|
1022719
1022905
|
"title": "Organization Simple",
|