@socketsecurity/sdk 1.8.2 → 1.8.3
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/CHANGELOG.md +5 -0
- package/dist/constants.d.ts +1 -1
- package/dist/constants.d.ts.map +1 -1
- package/dist/http-client.d.ts +1 -1
- package/dist/http-client.d.ts.map +1 -1
- package/dist/socket-sdk-class.js +6 -6
- package/dist/socket-sdk-class.js.map +1 -1
- package/dist/types.d.ts +26 -26
- package/dist/types.d.ts.map +1 -1
- package/package.json +3 -3
- package/types/api.d.ts +585 -132
package/types/api.d.ts
CHANGED
|
@@ -15,10 +15,8 @@ export interface paths {
|
|
|
15
15
|
*
|
|
16
16
|
* More information on purl and CycloneDX:
|
|
17
17
|
*
|
|
18
|
-
|
|
19
|
-
* - [
|
|
20
|
-
//cyclonedx.org/specification/overview/#components)
|
|
21
|
-
* - [CycloneDX Spec](https:
|
|
18
|
+
* - [`purl` Spec](https://github.com/package-url/purl-spec)
|
|
19
|
+
* - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
|
|
22
20
|
*
|
|
23
21
|
* This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
|
|
24
22
|
* Actively running analysis will be returned when available on subsequent runs.
|
|
@@ -312,7 +310,8 @@ export interface paths {
|
|
|
312
310
|
'/orgs/{org_slug}/diff-scans/from-repo/{repo_slug}': {
|
|
313
311
|
/**
|
|
314
312
|
* Create diff scan from repository HEAD full-scan
|
|
315
|
-
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files
|
|
313
|
+
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.
|
|
314
|
+
* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
|
|
316
315
|
* the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
|
|
317
316
|
*
|
|
318
317
|
* The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
|
|
@@ -594,8 +593,7 @@ export interface paths {
|
|
|
594
593
|
/**
|
|
595
594
|
* Get Organization License Policy
|
|
596
595
|
* @deprecated
|
|
597
|
-
|
|
598
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
596
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/viewlicensepolicy) instead.
|
|
599
597
|
*
|
|
600
598
|
* Retrieve the license policy of an organization.
|
|
601
599
|
*
|
|
@@ -607,7 +605,8 @@ export interface paths {
|
|
|
607
605
|
get: operations['getOrgLicensePolicy']
|
|
608
606
|
/**
|
|
609
607
|
* Update License Policy
|
|
610
|
-
* @description Set the organization's license policy
|
|
608
|
+
* @description Set the organization's license policy
|
|
609
|
+
*
|
|
611
610
|
* ## License policy schema
|
|
612
611
|
*
|
|
613
612
|
* ```json
|
|
@@ -642,13 +641,13 @@ export interface paths {
|
|
|
642
641
|
* 'commercial',
|
|
643
642
|
* 'patent'
|
|
644
643
|
*
|
|
645
|
-
|
|
646
|
-
* Users can learn more about [copyleft tiers](https:
|
|
644
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
647
645
|
*
|
|
648
646
|
*
|
|
649
647
|
* ## PURLs
|
|
650
648
|
*
|
|
651
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
649
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
650
|
+
*
|
|
652
651
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
653
652
|
*
|
|
654
653
|
* ### Examples:
|
|
@@ -673,7 +672,8 @@ export interface paths {
|
|
|
673
672
|
'/orgs/{org_slug}/settings/license-policy/view': {
|
|
674
673
|
/**
|
|
675
674
|
* Get License Policy (Beta)
|
|
676
|
-
* @description Returns an organization's license policy
|
|
675
|
+
* @description Returns an organization's license policy
|
|
676
|
+
*
|
|
677
677
|
* This endpoint consumes 1 unit of your quota.
|
|
678
678
|
*
|
|
679
679
|
* This endpoint requires the following org token scopes:
|
|
@@ -870,13 +870,11 @@ export interface paths {
|
|
|
870
870
|
/**
|
|
871
871
|
* Get Threat Feed Items (Deprecated)
|
|
872
872
|
* @deprecated
|
|
873
|
-
|
|
874
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
873
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgthreatfeeditems) instead.
|
|
875
874
|
*
|
|
876
875
|
* Paginated list of threat feed items.
|
|
877
876
|
*
|
|
878
|
-
|
|
879
|
-
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
877
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
880
878
|
*
|
|
881
879
|
* This endpoint consumes 1 unit of your quota.
|
|
882
880
|
*
|
|
@@ -890,8 +888,7 @@ export interface paths {
|
|
|
890
888
|
* Get Threat Feed Items (Beta)
|
|
891
889
|
* @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
|
|
892
890
|
*
|
|
893
|
-
|
|
894
|
-
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
891
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
895
892
|
*
|
|
896
893
|
* This endpoint consumes 1 unit of your quota.
|
|
897
894
|
*
|
|
@@ -986,13 +983,13 @@ export interface paths {
|
|
|
986
983
|
* 'commercial',
|
|
987
984
|
* 'patent'
|
|
988
985
|
*
|
|
989
|
-
|
|
990
|
-
* Users can learn more about [copyleft tiers](https:
|
|
986
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
991
987
|
*
|
|
992
988
|
*
|
|
993
989
|
* ## PURLs
|
|
994
990
|
*
|
|
995
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
991
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
992
|
+
*
|
|
996
993
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
997
994
|
*
|
|
998
995
|
* ### Examples:
|
|
@@ -1019,10 +1016,10 @@ export interface paths {
|
|
|
1019
1016
|
/**
|
|
1020
1017
|
* Saturate License Policy (Legacy)
|
|
1021
1018
|
* @deprecated
|
|
1022
|
-
|
|
1023
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1019
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorglicensepolicy) instead.
|
|
1024
1020
|
*
|
|
1025
|
-
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
|
|
1021
|
+
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
|
|
1022
|
+
* license data. For example, the saturated form of a license allow list which only specifies that
|
|
1026
1023
|
* licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
|
|
1027
1024
|
*
|
|
1028
1025
|
* ```json
|
|
@@ -1078,8 +1075,7 @@ export interface paths {
|
|
|
1078
1075
|
* PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
|
|
1079
1076
|
* CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
|
|
1080
1077
|
*
|
|
1081
|
-
|
|
1082
|
-
* readers can learn more about [copyleft tiers](https:
|
|
1078
|
+
* readers can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
1083
1079
|
*
|
|
1084
1080
|
* ### Example request bodies:
|
|
1085
1081
|
* ```json
|
|
@@ -1121,8 +1117,7 @@ export interface paths {
|
|
|
1121
1117
|
* ## Return value
|
|
1122
1118
|
*
|
|
1123
1119
|
* ```json
|
|
1124
|
-
// Response schema:
|
|
1125
|
-
*
|
|
1120
|
+
* // Response schema:
|
|
1126
1121
|
* Array<{
|
|
1127
1122
|
* licenseId: string,
|
|
1128
1123
|
* name?: string,
|
|
@@ -1132,8 +1127,7 @@ export interface paths {
|
|
|
1132
1127
|
* text?: string
|
|
1133
1128
|
* }>
|
|
1134
1129
|
*
|
|
1135
|
-
// Example response:
|
|
1136
|
-
*
|
|
1130
|
+
* // Example response:
|
|
1137
1131
|
* [
|
|
1138
1132
|
* {
|
|
1139
1133
|
* "licenseId": "Apache-2.0",
|
|
@@ -1193,13 +1187,13 @@ export interface paths {
|
|
|
1193
1187
|
* 'commercial',
|
|
1194
1188
|
* 'patent'
|
|
1195
1189
|
*
|
|
1196
|
-
|
|
1197
|
-
* Users can learn more about [copyleft tiers](https:
|
|
1190
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
1198
1191
|
*
|
|
1199
1192
|
*
|
|
1200
1193
|
* ## PURLs
|
|
1201
1194
|
*
|
|
1202
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
1195
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
1196
|
+
*
|
|
1203
1197
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
1204
1198
|
*
|
|
1205
1199
|
* ### Examples:
|
|
@@ -1270,8 +1264,7 @@ export interface paths {
|
|
|
1270
1264
|
/**
|
|
1271
1265
|
* Calculate settings
|
|
1272
1266
|
* @deprecated
|
|
1273
|
-
|
|
1274
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1267
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorgsecuritypolicy) instead.
|
|
1275
1268
|
*
|
|
1276
1269
|
* Get current settings for the requested organizations and default settings to allow deferrals.
|
|
1277
1270
|
*
|
|
@@ -1286,8 +1279,7 @@ export interface paths {
|
|
|
1286
1279
|
/**
|
|
1287
1280
|
* Get supported files for report
|
|
1288
1281
|
* @deprecated
|
|
1289
|
-
|
|
1290
|
-
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
|
|
1282
|
+
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https://docs.socket.dev/reference/getsupportedfiles) instead.
|
|
1291
1283
|
*
|
|
1292
1284
|
* This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
|
|
1293
1285
|
*
|
|
@@ -1307,8 +1299,7 @@ export interface paths {
|
|
|
1307
1299
|
/**
|
|
1308
1300
|
* Delete a report
|
|
1309
1301
|
* @deprecated
|
|
1310
|
-
|
|
1311
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1302
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
1312
1303
|
*
|
|
1313
1304
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
|
|
1314
1305
|
*
|
|
@@ -1323,8 +1314,7 @@ export interface paths {
|
|
|
1323
1314
|
/**
|
|
1324
1315
|
* Get list of reports
|
|
1325
1316
|
* @deprecated
|
|
1326
|
-
|
|
1327
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1317
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
1328
1318
|
*
|
|
1329
1319
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
|
|
1330
1320
|
*
|
|
@@ -1339,8 +1329,7 @@ export interface paths {
|
|
|
1339
1329
|
/**
|
|
1340
1330
|
* Create a report
|
|
1341
1331
|
* @deprecated
|
|
1342
|
-
|
|
1343
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1332
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/createorgfullscan) instead.
|
|
1344
1333
|
*
|
|
1345
1334
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
|
|
1346
1335
|
*
|
|
@@ -1362,8 +1351,7 @@ export interface paths {
|
|
|
1362
1351
|
/**
|
|
1363
1352
|
* View a report
|
|
1364
1353
|
* @deprecated
|
|
1365
|
-
|
|
1366
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1354
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgfullscan) instead.
|
|
1367
1355
|
*
|
|
1368
1356
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
|
|
1369
1357
|
*
|
|
@@ -1378,8 +1366,7 @@ export interface paths {
|
|
|
1378
1366
|
/**
|
|
1379
1367
|
* List GitHub repositories
|
|
1380
1368
|
* @deprecated
|
|
1381
|
-
|
|
1382
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1369
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgrepolist) instead.
|
|
1383
1370
|
*
|
|
1384
1371
|
* Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
|
|
1385
1372
|
*
|
|
@@ -1394,14 +1381,12 @@ export interface paths {
|
|
|
1394
1381
|
/**
|
|
1395
1382
|
* Get issues by package
|
|
1396
1383
|
* @deprecated
|
|
1397
|
-
|
|
1398
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1384
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
1399
1385
|
*
|
|
1400
1386
|
* Get all the issues related with a particular npm package version.
|
|
1401
1387
|
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
|
|
1402
1388
|
*
|
|
1403
|
-
|
|
1404
|
-
* You can [see here](https:
|
|
1389
|
+
* You can [see here](https://socket.dev/alerts) the full list of issues.
|
|
1405
1390
|
*
|
|
1406
1391
|
* This endpoint consumes 1 unit of your quota.
|
|
1407
1392
|
*
|
|
@@ -1414,8 +1399,7 @@ export interface paths {
|
|
|
1414
1399
|
/**
|
|
1415
1400
|
* Get score by package
|
|
1416
1401
|
* @deprecated
|
|
1417
|
-
|
|
1418
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1402
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/batchpackagefetch) instead.
|
|
1419
1403
|
*
|
|
1420
1404
|
* Get all the scores and metrics by category that are used to evaluate the package version.
|
|
1421
1405
|
*
|
|
@@ -1430,17 +1414,20 @@ export interface paths {
|
|
|
1430
1414
|
* - quality: Score factors relating to code quality (0-1)
|
|
1431
1415
|
* - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
|
|
1432
1416
|
* - linesOfCode: The number of lines of code in the package. Lower count contributes to a higher score.
|
|
1433
|
-
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score
|
|
1417
|
+
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.
|
|
1418
|
+
* - maintenance: Score factors relating to package maintenance (0-1)
|
|
1434
1419
|
* - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
|
|
1435
1420
|
* - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
|
|
1436
1421
|
* - versionCount: The total number of versions released. Higher count contributes to a higher score.
|
|
1437
1422
|
* - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
|
|
1438
1423
|
* - vulnerability: Score factors relating to package vulnerabilities (0-1)
|
|
1439
1424
|
* - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute to a higher score.
|
|
1440
|
-
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score
|
|
1425
|
+
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.
|
|
1426
|
+
* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
|
|
1441
1427
|
* - license: Score factors relating to package licensing (0-1)
|
|
1442
1428
|
* - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute to a higher score.
|
|
1443
|
-
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score
|
|
1429
|
+
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.
|
|
1430
|
+
* - miscellaneous: Miscellaneous metadata about the package version.
|
|
1444
1431
|
* - versionAuthorName/Email: The name and email of the version author.
|
|
1445
1432
|
* - fileCount: The number of files in the package.
|
|
1446
1433
|
* - byteCount: The total size in bytes of the package.
|
|
@@ -1457,8 +1444,7 @@ export interface paths {
|
|
|
1457
1444
|
/**
|
|
1458
1445
|
* Get organization analytics (unstable)
|
|
1459
1446
|
* @deprecated
|
|
1460
|
-
|
|
1461
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1447
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
|
|
1462
1448
|
*
|
|
1463
1449
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
1464
1450
|
*
|
|
@@ -1475,8 +1461,7 @@ export interface paths {
|
|
|
1475
1461
|
/**
|
|
1476
1462
|
* Get repository analytics
|
|
1477
1463
|
* @deprecated
|
|
1478
|
-
|
|
1479
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1464
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
|
|
1480
1465
|
*
|
|
1481
1466
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
1482
1467
|
*
|
|
@@ -1522,6 +1507,7 @@ export interface components {
|
|
|
1522
1507
|
repositoryType?: string
|
|
1523
1508
|
alerts?: Array<components['schemas']['SocketAlert']>
|
|
1524
1509
|
score?: components['schemas']['SocketScore']
|
|
1510
|
+
patch?: components['schemas']['SocketArtifactPatch']
|
|
1525
1511
|
/**
|
|
1526
1512
|
* @description Original unmodified PURL input string before normalization
|
|
1527
1513
|
* @default
|
|
@@ -1909,7 +1895,8 @@ export interface components {
|
|
|
1909
1895
|
*/
|
|
1910
1896
|
subpath?: string
|
|
1911
1897
|
/**
|
|
1912
|
-
* @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version
|
|
1898
|
+
* @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version
|
|
1899
|
+
* @default
|
|
1913
1900
|
*/
|
|
1914
1901
|
release?: string
|
|
1915
1902
|
}
|
|
@@ -1996,7 +1983,27 @@ export interface components {
|
|
|
1996
1983
|
* @default
|
|
1997
1984
|
*/
|
|
1998
1985
|
description: string
|
|
1986
|
+
/** @description Patches available to fix this specific alert */
|
|
1987
|
+
patch?: Array<{
|
|
1988
|
+
/**
|
|
1989
|
+
* @description Unique identifier for this patch
|
|
1990
|
+
* @default
|
|
1991
|
+
*/
|
|
1992
|
+
uuid: string
|
|
1993
|
+
/**
|
|
1994
|
+
* @description Access tier required for this patch (free or paid)
|
|
1995
|
+
* @default free
|
|
1996
|
+
* @enum {string}
|
|
1997
|
+
*/
|
|
1998
|
+
tier: 'free' | 'paid'
|
|
1999
|
+
/**
|
|
2000
|
+
* @description Indicates if this patch is deprecated and should not be used
|
|
2001
|
+
* @default false
|
|
2002
|
+
*/
|
|
2003
|
+
deprecated?: boolean
|
|
2004
|
+
}>
|
|
1999
2005
|
}
|
|
2006
|
+
patch?: components['schemas']['SocketPatch']
|
|
2000
2007
|
reachability?: {
|
|
2001
2008
|
head?: components['schemas']['ReachabilityResult']
|
|
2002
2009
|
base?: components['schemas']['ReachabilityResult']
|
|
@@ -2007,6 +2014,11 @@ export interface components {
|
|
|
2007
2014
|
*/
|
|
2008
2015
|
subType?: string
|
|
2009
2016
|
}
|
|
2017
|
+
SocketArtifactPatch: {
|
|
2018
|
+
appliedPatch?: components['schemas']['SocketPatch']
|
|
2019
|
+
/** @description List of available patches that can be applied to fix vulnerabilities */
|
|
2020
|
+
availablePatches?: Array<components['schemas']['SocketPatch']>
|
|
2021
|
+
}
|
|
2010
2022
|
LicenseDetails: Array<{
|
|
2011
2023
|
/**
|
|
2012
2024
|
* @description SPDX license expression in disjunctive normal form (e.g., '(MIT OR Apache-2.0)')
|
|
@@ -3961,6 +3973,117 @@ export interface components {
|
|
|
3961
3973
|
usage?: components['schemas']['SocketUsageRef']
|
|
3962
3974
|
}
|
|
3963
3975
|
}
|
|
3976
|
+
| {
|
|
3977
|
+
/** @enum {string} */
|
|
3978
|
+
type?: 'vsxProposedApiUsage'
|
|
3979
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
3980
|
+
/** @default */
|
|
3981
|
+
description: string
|
|
3982
|
+
props: {
|
|
3983
|
+
/** @default */
|
|
3984
|
+
proposals: string
|
|
3985
|
+
}
|
|
3986
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
3987
|
+
}
|
|
3988
|
+
}
|
|
3989
|
+
| {
|
|
3990
|
+
/** @enum {string} */
|
|
3991
|
+
type?: 'vsxActivationWildcard'
|
|
3992
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
3993
|
+
/** @default */
|
|
3994
|
+
description: string
|
|
3995
|
+
props: {
|
|
3996
|
+
/** @default */
|
|
3997
|
+
event: string
|
|
3998
|
+
}
|
|
3999
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4000
|
+
}
|
|
4001
|
+
}
|
|
4002
|
+
| {
|
|
4003
|
+
/** @enum {string} */
|
|
4004
|
+
type?: 'vsxWorkspaceContainsActivation'
|
|
4005
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4006
|
+
/** @default */
|
|
4007
|
+
description: string
|
|
4008
|
+
props: {
|
|
4009
|
+
/** @default */
|
|
4010
|
+
pattern: string
|
|
4011
|
+
}
|
|
4012
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4013
|
+
}
|
|
4014
|
+
}
|
|
4015
|
+
| {
|
|
4016
|
+
/** @enum {string} */
|
|
4017
|
+
type?: 'vsxUntrustedWorkspaceSupported'
|
|
4018
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4019
|
+
/** @default */
|
|
4020
|
+
description: string
|
|
4021
|
+
props: {
|
|
4022
|
+
/** @default */
|
|
4023
|
+
supported: string
|
|
4024
|
+
}
|
|
4025
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4026
|
+
}
|
|
4027
|
+
}
|
|
4028
|
+
| {
|
|
4029
|
+
/** @enum {string} */
|
|
4030
|
+
type?: 'vsxVirtualWorkspaceSupported'
|
|
4031
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4032
|
+
/** @default */
|
|
4033
|
+
description: string
|
|
4034
|
+
props: {
|
|
4035
|
+
/** @default */
|
|
4036
|
+
supported: string
|
|
4037
|
+
}
|
|
4038
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4039
|
+
}
|
|
4040
|
+
}
|
|
4041
|
+
| {
|
|
4042
|
+
/** @enum {string} */
|
|
4043
|
+
type?: 'vsxWebviewContribution'
|
|
4044
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4045
|
+
/** @default */
|
|
4046
|
+
description: string
|
|
4047
|
+
props: Record<string, never>
|
|
4048
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4049
|
+
}
|
|
4050
|
+
}
|
|
4051
|
+
| {
|
|
4052
|
+
/** @enum {string} */
|
|
4053
|
+
type?: 'vsxDebuggerContribution'
|
|
4054
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4055
|
+
/** @default */
|
|
4056
|
+
description: string
|
|
4057
|
+
props: Record<string, never>
|
|
4058
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4059
|
+
}
|
|
4060
|
+
}
|
|
4061
|
+
| {
|
|
4062
|
+
/** @enum {string} */
|
|
4063
|
+
type?: 'vsxExtensionDependency'
|
|
4064
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4065
|
+
/** @default */
|
|
4066
|
+
description: string
|
|
4067
|
+
props: {
|
|
4068
|
+
/** @default */
|
|
4069
|
+
extension: string
|
|
4070
|
+
}
|
|
4071
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4072
|
+
}
|
|
4073
|
+
}
|
|
4074
|
+
| {
|
|
4075
|
+
/** @enum {string} */
|
|
4076
|
+
type?: 'vsxExtensionPack'
|
|
4077
|
+
value?: components['schemas']['SocketIssueBasics'] & {
|
|
4078
|
+
/** @default */
|
|
4079
|
+
description: string
|
|
4080
|
+
props: {
|
|
4081
|
+
/** @default */
|
|
4082
|
+
count: string
|
|
4083
|
+
}
|
|
4084
|
+
usage?: components['schemas']['SocketUsageRef']
|
|
4085
|
+
}
|
|
4086
|
+
}
|
|
3964
4087
|
SocketMetricSchema: {
|
|
3965
4088
|
/** @default 0 */
|
|
3966
4089
|
score: number
|
|
@@ -4024,6 +4147,24 @@ export interface components {
|
|
|
4024
4147
|
| 'vulnerability'
|
|
4025
4148
|
| 'license'
|
|
4026
4149
|
| 'other'
|
|
4150
|
+
SocketPatch: {
|
|
4151
|
+
/**
|
|
4152
|
+
* @description Unique identifier for this patch
|
|
4153
|
+
* @default
|
|
4154
|
+
*/
|
|
4155
|
+
uuid: string
|
|
4156
|
+
/**
|
|
4157
|
+
* @description Access tier required for this patch (free or paid)
|
|
4158
|
+
* @default free
|
|
4159
|
+
* @enum {string}
|
|
4160
|
+
*/
|
|
4161
|
+
tier: 'free' | 'paid'
|
|
4162
|
+
/**
|
|
4163
|
+
* @description Indicates if this patch is deprecated and should not be used
|
|
4164
|
+
* @default false
|
|
4165
|
+
*/
|
|
4166
|
+
deprecated?: boolean
|
|
4167
|
+
}
|
|
4027
4168
|
ReachabilityResult: {
|
|
4028
4169
|
/**
|
|
4029
4170
|
* @description Type of reachability analysis performed
|
|
@@ -4330,8 +4471,7 @@ export interface components {
|
|
|
4330
4471
|
headers: {
|
|
4331
4472
|
/**
|
|
4332
4473
|
* @description Retry contacting the endpoint *at least* after seconds.
|
|
4333
|
-
|
|
4334
|
-
* See https:
|
|
4474
|
+
* See https://tools.ietf.org/html/rfc7231#section-7.1.3
|
|
4335
4475
|
*/
|
|
4336
4476
|
'Retry-After'?: number
|
|
4337
4477
|
}
|
|
@@ -4394,10 +4534,8 @@ export interface operations {
|
|
|
4394
4534
|
*
|
|
4395
4535
|
* More information on purl and CycloneDX:
|
|
4396
4536
|
*
|
|
4397
|
-
|
|
4398
|
-
* - [
|
|
4399
|
-
//cyclonedx.org/specification/overview/#components)
|
|
4400
|
-
* - [CycloneDX Spec](https:
|
|
4537
|
+
* - [`purl` Spec](https://github.com/package-url/purl-spec)
|
|
4538
|
+
* - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
|
|
4401
4539
|
*
|
|
4402
4540
|
* This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
|
|
4403
4541
|
* Actively running analysis will be returned when available on subsequent runs.
|
|
@@ -5241,7 +5379,8 @@ export interface operations {
|
|
|
5241
5379
|
query?: {
|
|
5242
5380
|
/**
|
|
5243
5381
|
* @description The person(s) who created the BOM.
|
|
5244
|
-
* Set this value if you're intending the modify the BOM and claim authorship
|
|
5382
|
+
* Set this value if you're intending the modify the BOM and claim authorship.
|
|
5383
|
+
*/
|
|
5245
5384
|
author?: string
|
|
5246
5385
|
/** @description Dependency track project group */
|
|
5247
5386
|
project_group?: string
|
|
@@ -5302,7 +5441,8 @@ export interface operations {
|
|
|
5302
5441
|
query?: {
|
|
5303
5442
|
/**
|
|
5304
5443
|
* @description The person(s) who created the BOM.
|
|
5305
|
-
* Set this value if you're intending the modify the BOM and claim authorship
|
|
5444
|
+
* Set this value if you're intending the modify the BOM and claim authorship.
|
|
5445
|
+
*/
|
|
5306
5446
|
author?: string
|
|
5307
5447
|
/** @description Dependency track project group */
|
|
5308
5448
|
project_group?: string
|
|
@@ -5696,7 +5836,8 @@ export interface operations {
|
|
|
5696
5836
|
}
|
|
5697
5837
|
/**
|
|
5698
5838
|
* Create diff scan from repository HEAD full-scan
|
|
5699
|
-
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files
|
|
5839
|
+
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.
|
|
5840
|
+
* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
|
|
5700
5841
|
* the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
|
|
5701
5842
|
*
|
|
5702
5843
|
* The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
|
|
@@ -7785,6 +7926,69 @@ export interface operations {
|
|
|
7785
7926
|
*/
|
|
7786
7927
|
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7787
7928
|
}
|
|
7929
|
+
vsxProposedApiUsage?: {
|
|
7930
|
+
/**
|
|
7931
|
+
* @description The action to take for vsxProposedApiUsage issues.
|
|
7932
|
+
* @enum {string}
|
|
7933
|
+
*/
|
|
7934
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7935
|
+
}
|
|
7936
|
+
vsxActivationWildcard?: {
|
|
7937
|
+
/**
|
|
7938
|
+
* @description The action to take for vsxActivationWildcard issues.
|
|
7939
|
+
* @enum {string}
|
|
7940
|
+
*/
|
|
7941
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7942
|
+
}
|
|
7943
|
+
vsxWorkspaceContainsActivation?: {
|
|
7944
|
+
/**
|
|
7945
|
+
* @description The action to take for vsxWorkspaceContainsActivation issues.
|
|
7946
|
+
* @enum {string}
|
|
7947
|
+
*/
|
|
7948
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7949
|
+
}
|
|
7950
|
+
vsxUntrustedWorkspaceSupported?: {
|
|
7951
|
+
/**
|
|
7952
|
+
* @description The action to take for vsxUntrustedWorkspaceSupported issues.
|
|
7953
|
+
* @enum {string}
|
|
7954
|
+
*/
|
|
7955
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7956
|
+
}
|
|
7957
|
+
vsxVirtualWorkspaceSupported?: {
|
|
7958
|
+
/**
|
|
7959
|
+
* @description The action to take for vsxVirtualWorkspaceSupported issues.
|
|
7960
|
+
* @enum {string}
|
|
7961
|
+
*/
|
|
7962
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7963
|
+
}
|
|
7964
|
+
vsxWebviewContribution?: {
|
|
7965
|
+
/**
|
|
7966
|
+
* @description The action to take for vsxWebviewContribution issues.
|
|
7967
|
+
* @enum {string}
|
|
7968
|
+
*/
|
|
7969
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7970
|
+
}
|
|
7971
|
+
vsxDebuggerContribution?: {
|
|
7972
|
+
/**
|
|
7973
|
+
* @description The action to take for vsxDebuggerContribution issues.
|
|
7974
|
+
* @enum {string}
|
|
7975
|
+
*/
|
|
7976
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7977
|
+
}
|
|
7978
|
+
vsxExtensionDependency?: {
|
|
7979
|
+
/**
|
|
7980
|
+
* @description The action to take for vsxExtensionDependency issues.
|
|
7981
|
+
* @enum {string}
|
|
7982
|
+
*/
|
|
7983
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7984
|
+
}
|
|
7985
|
+
vsxExtensionPack?: {
|
|
7986
|
+
/**
|
|
7987
|
+
* @description The action to take for vsxExtensionPack issues.
|
|
7988
|
+
* @enum {string}
|
|
7989
|
+
*/
|
|
7990
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
7991
|
+
}
|
|
7788
7992
|
} | null
|
|
7789
7993
|
/**
|
|
7790
7994
|
* @description The default security policy for the repository label
|
|
@@ -8552,6 +8756,69 @@ export interface operations {
|
|
|
8552
8756
|
*/
|
|
8553
8757
|
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8554
8758
|
}
|
|
8759
|
+
vsxProposedApiUsage?: {
|
|
8760
|
+
/**
|
|
8761
|
+
* @description The action to take for vsxProposedApiUsage issues.
|
|
8762
|
+
* @enum {string}
|
|
8763
|
+
*/
|
|
8764
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8765
|
+
}
|
|
8766
|
+
vsxActivationWildcard?: {
|
|
8767
|
+
/**
|
|
8768
|
+
* @description The action to take for vsxActivationWildcard issues.
|
|
8769
|
+
* @enum {string}
|
|
8770
|
+
*/
|
|
8771
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8772
|
+
}
|
|
8773
|
+
vsxWorkspaceContainsActivation?: {
|
|
8774
|
+
/**
|
|
8775
|
+
* @description The action to take for vsxWorkspaceContainsActivation issues.
|
|
8776
|
+
* @enum {string}
|
|
8777
|
+
*/
|
|
8778
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8779
|
+
}
|
|
8780
|
+
vsxUntrustedWorkspaceSupported?: {
|
|
8781
|
+
/**
|
|
8782
|
+
* @description The action to take for vsxUntrustedWorkspaceSupported issues.
|
|
8783
|
+
* @enum {string}
|
|
8784
|
+
*/
|
|
8785
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8786
|
+
}
|
|
8787
|
+
vsxVirtualWorkspaceSupported?: {
|
|
8788
|
+
/**
|
|
8789
|
+
* @description The action to take for vsxVirtualWorkspaceSupported issues.
|
|
8790
|
+
* @enum {string}
|
|
8791
|
+
*/
|
|
8792
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8793
|
+
}
|
|
8794
|
+
vsxWebviewContribution?: {
|
|
8795
|
+
/**
|
|
8796
|
+
* @description The action to take for vsxWebviewContribution issues.
|
|
8797
|
+
* @enum {string}
|
|
8798
|
+
*/
|
|
8799
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8800
|
+
}
|
|
8801
|
+
vsxDebuggerContribution?: {
|
|
8802
|
+
/**
|
|
8803
|
+
* @description The action to take for vsxDebuggerContribution issues.
|
|
8804
|
+
* @enum {string}
|
|
8805
|
+
*/
|
|
8806
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8807
|
+
}
|
|
8808
|
+
vsxExtensionDependency?: {
|
|
8809
|
+
/**
|
|
8810
|
+
* @description The action to take for vsxExtensionDependency issues.
|
|
8811
|
+
* @enum {string}
|
|
8812
|
+
*/
|
|
8813
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8814
|
+
}
|
|
8815
|
+
vsxExtensionPack?: {
|
|
8816
|
+
/**
|
|
8817
|
+
* @description The action to take for vsxExtensionPack issues.
|
|
8818
|
+
* @enum {string}
|
|
8819
|
+
*/
|
|
8820
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
8821
|
+
}
|
|
8555
8822
|
}
|
|
8556
8823
|
/**
|
|
8557
8824
|
* @description The default security policy for the repository label
|
|
@@ -9473,6 +9740,69 @@ export interface operations {
|
|
|
9473
9740
|
*/
|
|
9474
9741
|
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9475
9742
|
}
|
|
9743
|
+
vsxProposedApiUsage?: {
|
|
9744
|
+
/**
|
|
9745
|
+
* @description The action to take for vsxProposedApiUsage issues.
|
|
9746
|
+
* @enum {string}
|
|
9747
|
+
*/
|
|
9748
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9749
|
+
}
|
|
9750
|
+
vsxActivationWildcard?: {
|
|
9751
|
+
/**
|
|
9752
|
+
* @description The action to take for vsxActivationWildcard issues.
|
|
9753
|
+
* @enum {string}
|
|
9754
|
+
*/
|
|
9755
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9756
|
+
}
|
|
9757
|
+
vsxWorkspaceContainsActivation?: {
|
|
9758
|
+
/**
|
|
9759
|
+
* @description The action to take for vsxWorkspaceContainsActivation issues.
|
|
9760
|
+
* @enum {string}
|
|
9761
|
+
*/
|
|
9762
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9763
|
+
}
|
|
9764
|
+
vsxUntrustedWorkspaceSupported?: {
|
|
9765
|
+
/**
|
|
9766
|
+
* @description The action to take for vsxUntrustedWorkspaceSupported issues.
|
|
9767
|
+
* @enum {string}
|
|
9768
|
+
*/
|
|
9769
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9770
|
+
}
|
|
9771
|
+
vsxVirtualWorkspaceSupported?: {
|
|
9772
|
+
/**
|
|
9773
|
+
* @description The action to take for vsxVirtualWorkspaceSupported issues.
|
|
9774
|
+
* @enum {string}
|
|
9775
|
+
*/
|
|
9776
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9777
|
+
}
|
|
9778
|
+
vsxWebviewContribution?: {
|
|
9779
|
+
/**
|
|
9780
|
+
* @description The action to take for vsxWebviewContribution issues.
|
|
9781
|
+
* @enum {string}
|
|
9782
|
+
*/
|
|
9783
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9784
|
+
}
|
|
9785
|
+
vsxDebuggerContribution?: {
|
|
9786
|
+
/**
|
|
9787
|
+
* @description The action to take for vsxDebuggerContribution issues.
|
|
9788
|
+
* @enum {string}
|
|
9789
|
+
*/
|
|
9790
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9791
|
+
}
|
|
9792
|
+
vsxExtensionDependency?: {
|
|
9793
|
+
/**
|
|
9794
|
+
* @description The action to take for vsxExtensionDependency issues.
|
|
9795
|
+
* @enum {string}
|
|
9796
|
+
*/
|
|
9797
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9798
|
+
}
|
|
9799
|
+
vsxExtensionPack?: {
|
|
9800
|
+
/**
|
|
9801
|
+
* @description The action to take for vsxExtensionPack issues.
|
|
9802
|
+
* @enum {string}
|
|
9803
|
+
*/
|
|
9804
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
9805
|
+
}
|
|
9476
9806
|
}
|
|
9477
9807
|
/**
|
|
9478
9808
|
* @description The default security policy for the organization
|
|
@@ -10233,6 +10563,69 @@ export interface operations {
|
|
|
10233
10563
|
*/
|
|
10234
10564
|
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10235
10565
|
}
|
|
10566
|
+
vsxProposedApiUsage?: {
|
|
10567
|
+
/**
|
|
10568
|
+
* @description The action to take for vsxProposedApiUsage issues.
|
|
10569
|
+
* @enum {string}
|
|
10570
|
+
*/
|
|
10571
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10572
|
+
}
|
|
10573
|
+
vsxActivationWildcard?: {
|
|
10574
|
+
/**
|
|
10575
|
+
* @description The action to take for vsxActivationWildcard issues.
|
|
10576
|
+
* @enum {string}
|
|
10577
|
+
*/
|
|
10578
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10579
|
+
}
|
|
10580
|
+
vsxWorkspaceContainsActivation?: {
|
|
10581
|
+
/**
|
|
10582
|
+
* @description The action to take for vsxWorkspaceContainsActivation issues.
|
|
10583
|
+
* @enum {string}
|
|
10584
|
+
*/
|
|
10585
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10586
|
+
}
|
|
10587
|
+
vsxUntrustedWorkspaceSupported?: {
|
|
10588
|
+
/**
|
|
10589
|
+
* @description The action to take for vsxUntrustedWorkspaceSupported issues.
|
|
10590
|
+
* @enum {string}
|
|
10591
|
+
*/
|
|
10592
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10593
|
+
}
|
|
10594
|
+
vsxVirtualWorkspaceSupported?: {
|
|
10595
|
+
/**
|
|
10596
|
+
* @description The action to take for vsxVirtualWorkspaceSupported issues.
|
|
10597
|
+
* @enum {string}
|
|
10598
|
+
*/
|
|
10599
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10600
|
+
}
|
|
10601
|
+
vsxWebviewContribution?: {
|
|
10602
|
+
/**
|
|
10603
|
+
* @description The action to take for vsxWebviewContribution issues.
|
|
10604
|
+
* @enum {string}
|
|
10605
|
+
*/
|
|
10606
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10607
|
+
}
|
|
10608
|
+
vsxDebuggerContribution?: {
|
|
10609
|
+
/**
|
|
10610
|
+
* @description The action to take for vsxDebuggerContribution issues.
|
|
10611
|
+
* @enum {string}
|
|
10612
|
+
*/
|
|
10613
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10614
|
+
}
|
|
10615
|
+
vsxExtensionDependency?: {
|
|
10616
|
+
/**
|
|
10617
|
+
* @description The action to take for vsxExtensionDependency issues.
|
|
10618
|
+
* @enum {string}
|
|
10619
|
+
*/
|
|
10620
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10621
|
+
}
|
|
10622
|
+
vsxExtensionPack?: {
|
|
10623
|
+
/**
|
|
10624
|
+
* @description The action to take for vsxExtensionPack issues.
|
|
10625
|
+
* @enum {string}
|
|
10626
|
+
*/
|
|
10627
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10628
|
+
}
|
|
10236
10629
|
}
|
|
10237
10630
|
/**
|
|
10238
10631
|
* @description Reset the policy rules to the default. When set to true, do not include any policyRules updates.
|
|
@@ -10962,6 +11355,69 @@ export interface operations {
|
|
|
10962
11355
|
*/
|
|
10963
11356
|
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
10964
11357
|
}
|
|
11358
|
+
vsxProposedApiUsage?: {
|
|
11359
|
+
/**
|
|
11360
|
+
* @description The action to take for vsxProposedApiUsage issues.
|
|
11361
|
+
* @enum {string}
|
|
11362
|
+
*/
|
|
11363
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11364
|
+
}
|
|
11365
|
+
vsxActivationWildcard?: {
|
|
11366
|
+
/**
|
|
11367
|
+
* @description The action to take for vsxActivationWildcard issues.
|
|
11368
|
+
* @enum {string}
|
|
11369
|
+
*/
|
|
11370
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11371
|
+
}
|
|
11372
|
+
vsxWorkspaceContainsActivation?: {
|
|
11373
|
+
/**
|
|
11374
|
+
* @description The action to take for vsxWorkspaceContainsActivation issues.
|
|
11375
|
+
* @enum {string}
|
|
11376
|
+
*/
|
|
11377
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11378
|
+
}
|
|
11379
|
+
vsxUntrustedWorkspaceSupported?: {
|
|
11380
|
+
/**
|
|
11381
|
+
* @description The action to take for vsxUntrustedWorkspaceSupported issues.
|
|
11382
|
+
* @enum {string}
|
|
11383
|
+
*/
|
|
11384
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11385
|
+
}
|
|
11386
|
+
vsxVirtualWorkspaceSupported?: {
|
|
11387
|
+
/**
|
|
11388
|
+
* @description The action to take for vsxVirtualWorkspaceSupported issues.
|
|
11389
|
+
* @enum {string}
|
|
11390
|
+
*/
|
|
11391
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11392
|
+
}
|
|
11393
|
+
vsxWebviewContribution?: {
|
|
11394
|
+
/**
|
|
11395
|
+
* @description The action to take for vsxWebviewContribution issues.
|
|
11396
|
+
* @enum {string}
|
|
11397
|
+
*/
|
|
11398
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11399
|
+
}
|
|
11400
|
+
vsxDebuggerContribution?: {
|
|
11401
|
+
/**
|
|
11402
|
+
* @description The action to take for vsxDebuggerContribution issues.
|
|
11403
|
+
* @enum {string}
|
|
11404
|
+
*/
|
|
11405
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11406
|
+
}
|
|
11407
|
+
vsxExtensionDependency?: {
|
|
11408
|
+
/**
|
|
11409
|
+
* @description The action to take for vsxExtensionDependency issues.
|
|
11410
|
+
* @enum {string}
|
|
11411
|
+
*/
|
|
11412
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11413
|
+
}
|
|
11414
|
+
vsxExtensionPack?: {
|
|
11415
|
+
/**
|
|
11416
|
+
* @description The action to take for vsxExtensionPack issues.
|
|
11417
|
+
* @enum {string}
|
|
11418
|
+
*/
|
|
11419
|
+
action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
|
|
11420
|
+
}
|
|
10965
11421
|
}
|
|
10966
11422
|
/**
|
|
10967
11423
|
* @description The default security policy for the organization
|
|
@@ -10982,8 +11438,7 @@ export interface operations {
|
|
|
10982
11438
|
/**
|
|
10983
11439
|
* Get Organization License Policy
|
|
10984
11440
|
* @deprecated
|
|
10985
|
-
|
|
10986
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
11441
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/viewlicensepolicy) instead.
|
|
10987
11442
|
*
|
|
10988
11443
|
* Retrieve the license policy of an organization.
|
|
10989
11444
|
*
|
|
@@ -11015,7 +11470,8 @@ export interface operations {
|
|
|
11015
11470
|
}
|
|
11016
11471
|
/**
|
|
11017
11472
|
* Update License Policy
|
|
11018
|
-
* @description Set the organization's license policy
|
|
11473
|
+
* @description Set the organization's license policy
|
|
11474
|
+
*
|
|
11019
11475
|
* ## License policy schema
|
|
11020
11476
|
*
|
|
11021
11477
|
* ```json
|
|
@@ -11050,13 +11506,13 @@ export interface operations {
|
|
|
11050
11506
|
* 'commercial',
|
|
11051
11507
|
* 'patent'
|
|
11052
11508
|
*
|
|
11053
|
-
|
|
11054
|
-
* Users can learn more about [copyleft tiers](https:
|
|
11509
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
11055
11510
|
*
|
|
11056
11511
|
*
|
|
11057
11512
|
* ## PURLs
|
|
11058
11513
|
*
|
|
11059
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
11514
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
11515
|
+
*
|
|
11060
11516
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
11061
11517
|
*
|
|
11062
11518
|
* ### Examples:
|
|
@@ -11108,7 +11564,8 @@ export interface operations {
|
|
|
11108
11564
|
}
|
|
11109
11565
|
/**
|
|
11110
11566
|
* Get License Policy (Beta)
|
|
11111
|
-
* @description Returns an organization's license policy
|
|
11567
|
+
* @description Returns an organization's license policy
|
|
11568
|
+
*
|
|
11112
11569
|
* This endpoint consumes 1 unit of your quota.
|
|
11113
11570
|
*
|
|
11114
11571
|
* This endpoint requires the following org token scopes:
|
|
@@ -11257,8 +11714,10 @@ export interface operations {
|
|
|
11257
11714
|
'filters.artifactType'?: string
|
|
11258
11715
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11259
11716
|
'filters.artifactType.notIn'?: string
|
|
11260
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11261
|
-
|
|
11717
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11718
|
+
'filters.alertAction'?: string
|
|
11719
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11720
|
+
'filters.alertAction.notIn'?: string
|
|
11262
11721
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
|
|
11263
11722
|
'filters.alertActionSourceType'?: string
|
|
11264
11723
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
@@ -11428,7 +11887,8 @@ export interface operations {
|
|
|
11428
11887
|
artifactName?: string[]
|
|
11429
11888
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11430
11889
|
artifactType?: string[]
|
|
11431
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11890
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11891
|
+
alertAction?: string[]
|
|
11432
11892
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
11433
11893
|
alertActionSourceType?: string[]
|
|
11434
11894
|
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
@@ -11506,8 +11966,10 @@ export interface operations {
|
|
|
11506
11966
|
'filters.artifactType'?: string
|
|
11507
11967
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11508
11968
|
'filters.artifactType.notIn'?: string
|
|
11509
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11510
|
-
|
|
11969
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11970
|
+
'filters.alertAction'?: string
|
|
11971
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11972
|
+
'filters.alertAction.notIn'?: string
|
|
11511
11973
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
|
|
11512
11974
|
'filters.alertActionSourceType'?: string
|
|
11513
11975
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
@@ -11593,7 +12055,8 @@ export interface operations {
|
|
|
11593
12055
|
artifactName?: string[]
|
|
11594
12056
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11595
12057
|
artifactType?: string[]
|
|
11596
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
12058
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
12059
|
+
alertAction?: string[]
|
|
11597
12060
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
11598
12061
|
alertActionSourceType?: string[]
|
|
11599
12062
|
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
@@ -11977,12 +12440,15 @@ export interface operations {
|
|
|
11977
12440
|
| 'ChangePlanSubscriptionSeats'
|
|
11978
12441
|
| 'CreateApiToken'
|
|
11979
12442
|
| 'CreateLabel'
|
|
12443
|
+
| 'CreateWebhook'
|
|
11980
12444
|
| 'DeleteFullScan'
|
|
11981
12445
|
| 'DeleteLabel'
|
|
11982
12446
|
| 'DeleteLabelSetting'
|
|
11983
12447
|
| 'DeleteReport'
|
|
11984
12448
|
| 'DeleteRepository'
|
|
12449
|
+
| 'DeleteWebhook'
|
|
11985
12450
|
| 'DisassociateLabel'
|
|
12451
|
+
| 'DowngradeOrganizationPlan'
|
|
11986
12452
|
| 'JoinOrganization'
|
|
11987
12453
|
| 'RemoveLicenseOverlay'
|
|
11988
12454
|
| 'RemoveMember'
|
|
@@ -12004,6 +12470,7 @@ export interface operations {
|
|
|
12004
12470
|
| 'UpdateLabel'
|
|
12005
12471
|
| 'UpdateLabelSetting'
|
|
12006
12472
|
| 'UpdateOrganizationSetting'
|
|
12473
|
+
| 'UpdateWebhook'
|
|
12007
12474
|
| 'UpgradeOrganizationPlan'
|
|
12008
12475
|
/** @description Number of events per page */
|
|
12009
12476
|
per_page?: number
|
|
@@ -12608,13 +13075,11 @@ export interface operations {
|
|
|
12608
13075
|
/**
|
|
12609
13076
|
* Get Threat Feed Items (Deprecated)
|
|
12610
13077
|
* @deprecated
|
|
12611
|
-
|
|
12612
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13078
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgthreatfeeditems) instead.
|
|
12613
13079
|
*
|
|
12614
13080
|
* Paginated list of threat feed items.
|
|
12615
13081
|
*
|
|
12616
|
-
|
|
12617
|
-
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
13082
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
12618
13083
|
*
|
|
12619
13084
|
* This endpoint consumes 1 unit of your quota.
|
|
12620
13085
|
*
|
|
@@ -12714,8 +13179,7 @@ export interface operations {
|
|
|
12714
13179
|
* Get Threat Feed Items (Beta)
|
|
12715
13180
|
* @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
|
|
12716
13181
|
*
|
|
12717
|
-
|
|
12718
|
-
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
13182
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
12719
13183
|
*
|
|
12720
13184
|
* This endpoint consumes 1 unit of your quota.
|
|
12721
13185
|
*
|
|
@@ -12902,13 +13366,13 @@ export interface operations {
|
|
|
12902
13366
|
* 'commercial',
|
|
12903
13367
|
* 'patent'
|
|
12904
13368
|
*
|
|
12905
|
-
|
|
12906
|
-
* Users can learn more about [copyleft tiers](https:
|
|
13369
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
12907
13370
|
*
|
|
12908
13371
|
*
|
|
12909
13372
|
* ## PURLs
|
|
12910
13373
|
*
|
|
12911
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
13374
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
13375
|
+
*
|
|
12912
13376
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
12913
13377
|
*
|
|
12914
13378
|
* ### Examples:
|
|
@@ -12963,10 +13427,10 @@ export interface operations {
|
|
|
12963
13427
|
/**
|
|
12964
13428
|
* Saturate License Policy (Legacy)
|
|
12965
13429
|
* @deprecated
|
|
12966
|
-
|
|
12967
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13430
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorglicensepolicy) instead.
|
|
12968
13431
|
*
|
|
12969
|
-
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
|
|
13432
|
+
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
|
|
13433
|
+
* license data. For example, the saturated form of a license allow list which only specifies that
|
|
12970
13434
|
* licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
|
|
12971
13435
|
*
|
|
12972
13436
|
* ```json
|
|
@@ -13022,8 +13486,7 @@ export interface operations {
|
|
|
13022
13486
|
* PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
|
|
13023
13487
|
* CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
|
|
13024
13488
|
*
|
|
13025
|
-
|
|
13026
|
-
* readers can learn more about [copyleft tiers](https:
|
|
13489
|
+
* readers can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
13027
13490
|
*
|
|
13028
13491
|
* ### Example request bodies:
|
|
13029
13492
|
* ```json
|
|
@@ -13094,8 +13557,7 @@ export interface operations {
|
|
|
13094
13557
|
* ## Return value
|
|
13095
13558
|
*
|
|
13096
13559
|
* ```json
|
|
13097
|
-
// Response schema:
|
|
13098
|
-
*
|
|
13560
|
+
* // Response schema:
|
|
13099
13561
|
* Array<{
|
|
13100
13562
|
* licenseId: string,
|
|
13101
13563
|
* name?: string,
|
|
@@ -13105,8 +13567,7 @@ export interface operations {
|
|
|
13105
13567
|
* text?: string
|
|
13106
13568
|
* }>
|
|
13107
13569
|
*
|
|
13108
|
-
// Example response:
|
|
13109
|
-
*
|
|
13570
|
+
* // Example response:
|
|
13110
13571
|
* [
|
|
13111
13572
|
* {
|
|
13112
13573
|
* "licenseId": "Apache-2.0",
|
|
@@ -13166,13 +13627,13 @@ export interface operations {
|
|
|
13166
13627
|
* 'commercial',
|
|
13167
13628
|
* 'patent'
|
|
13168
13629
|
*
|
|
13169
|
-
|
|
13170
|
-
* Users can learn more about [copyleft tiers](https:
|
|
13630
|
+
* Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
13171
13631
|
*
|
|
13172
13632
|
*
|
|
13173
13633
|
* ## PURLs
|
|
13174
13634
|
*
|
|
13175
|
-
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc
|
|
13635
|
+
* Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
|
|
13636
|
+
*
|
|
13176
13637
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
13177
13638
|
*
|
|
13178
13639
|
* ### Examples:
|
|
@@ -13341,8 +13802,7 @@ export interface operations {
|
|
|
13341
13802
|
/**
|
|
13342
13803
|
* Calculate settings
|
|
13343
13804
|
* @deprecated
|
|
13344
|
-
|
|
13345
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13805
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorgsecuritypolicy) instead.
|
|
13346
13806
|
*
|
|
13347
13807
|
* Get current settings for the requested organizations and default settings to allow deferrals.
|
|
13348
13808
|
*
|
|
@@ -13362,7 +13822,8 @@ export interface operations {
|
|
|
13362
13822
|
}
|
|
13363
13823
|
}
|
|
13364
13824
|
responses: {
|
|
13365
|
-
/** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */
|
|
13825
|
+
/** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */
|
|
13826
|
+
200: {
|
|
13366
13827
|
content: {
|
|
13367
13828
|
'application/json': {
|
|
13368
13829
|
defaults: {
|
|
@@ -13399,8 +13860,7 @@ export interface operations {
|
|
|
13399
13860
|
/**
|
|
13400
13861
|
* Get supported files for report
|
|
13401
13862
|
* @deprecated
|
|
13402
|
-
|
|
13403
|
-
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
|
|
13863
|
+
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https://docs.socket.dev/reference/getsupportedfiles) instead.
|
|
13404
13864
|
*
|
|
13405
13865
|
* This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
|
|
13406
13866
|
*
|
|
@@ -13436,8 +13896,7 @@ export interface operations {
|
|
|
13436
13896
|
/**
|
|
13437
13897
|
* Delete a report
|
|
13438
13898
|
* @deprecated
|
|
13439
|
-
|
|
13440
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13899
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
13441
13900
|
*
|
|
13442
13901
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
|
|
13443
13902
|
*
|
|
@@ -13472,8 +13931,7 @@ export interface operations {
|
|
|
13472
13931
|
/**
|
|
13473
13932
|
* Get list of reports
|
|
13474
13933
|
* @deprecated
|
|
13475
|
-
|
|
13476
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13934
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
13477
13935
|
*
|
|
13478
13936
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
|
|
13479
13937
|
*
|
|
@@ -13525,8 +13983,7 @@ export interface operations {
|
|
|
13525
13983
|
/**
|
|
13526
13984
|
* Create a report
|
|
13527
13985
|
* @deprecated
|
|
13528
|
-
|
|
13529
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13986
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/createorgfullscan) instead.
|
|
13530
13987
|
*
|
|
13531
13988
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
|
|
13532
13989
|
*
|
|
@@ -13574,8 +14031,7 @@ export interface operations {
|
|
|
13574
14031
|
/**
|
|
13575
14032
|
* View a report
|
|
13576
14033
|
* @deprecated
|
|
13577
|
-
|
|
13578
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14034
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgfullscan) instead.
|
|
13579
14035
|
*
|
|
13580
14036
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
|
|
13581
14037
|
*
|
|
@@ -13608,8 +14064,7 @@ export interface operations {
|
|
|
13608
14064
|
/**
|
|
13609
14065
|
* List GitHub repositories
|
|
13610
14066
|
* @deprecated
|
|
13611
|
-
|
|
13612
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14067
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgrepolist) instead.
|
|
13613
14068
|
*
|
|
13614
14069
|
* Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
|
|
13615
14070
|
*
|
|
@@ -13666,14 +14121,12 @@ export interface operations {
|
|
|
13666
14121
|
/**
|
|
13667
14122
|
* Get issues by package
|
|
13668
14123
|
* @deprecated
|
|
13669
|
-
|
|
13670
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14124
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
|
|
13671
14125
|
*
|
|
13672
14126
|
* Get all the issues related with a particular npm package version.
|
|
13673
14127
|
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
|
|
13674
14128
|
*
|
|
13675
|
-
|
|
13676
|
-
* You can [see here](https:
|
|
14129
|
+
* You can [see here](https://socket.dev/alerts) the full list of issues.
|
|
13677
14130
|
*
|
|
13678
14131
|
* This endpoint consumes 1 unit of your quota.
|
|
13679
14132
|
*
|
|
@@ -13704,8 +14157,7 @@ export interface operations {
|
|
|
13704
14157
|
/**
|
|
13705
14158
|
* Get score by package
|
|
13706
14159
|
* @deprecated
|
|
13707
|
-
|
|
13708
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14160
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/batchpackagefetch) instead.
|
|
13709
14161
|
*
|
|
13710
14162
|
* Get all the scores and metrics by category that are used to evaluate the package version.
|
|
13711
14163
|
*
|
|
@@ -13720,17 +14172,20 @@ export interface operations {
|
|
|
13720
14172
|
* - quality: Score factors relating to code quality (0-1)
|
|
13721
14173
|
* - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
|
|
13722
14174
|
* - linesOfCode: The number of lines of code in the package. Lower count contributes to a higher score.
|
|
13723
|
-
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score
|
|
14175
|
+
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.
|
|
14176
|
+
* - maintenance: Score factors relating to package maintenance (0-1)
|
|
13724
14177
|
* - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
|
|
13725
14178
|
* - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
|
|
13726
14179
|
* - versionCount: The total number of versions released. Higher count contributes to a higher score.
|
|
13727
14180
|
* - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
|
|
13728
14181
|
* - vulnerability: Score factors relating to package vulnerabilities (0-1)
|
|
13729
14182
|
* - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute to a higher score.
|
|
13730
|
-
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score
|
|
14183
|
+
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.
|
|
14184
|
+
* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
|
|
13731
14185
|
* - license: Score factors relating to package licensing (0-1)
|
|
13732
14186
|
* - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute to a higher score.
|
|
13733
|
-
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score
|
|
14187
|
+
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.
|
|
14188
|
+
* - miscellaneous: Miscellaneous metadata about the package version.
|
|
13734
14189
|
* - versionAuthorName/Email: The name and email of the version author.
|
|
13735
14190
|
* - fileCount: The number of files in the package.
|
|
13736
14191
|
* - byteCount: The total size in bytes of the package.
|
|
@@ -13765,8 +14220,7 @@ export interface operations {
|
|
|
13765
14220
|
/**
|
|
13766
14221
|
* Get organization analytics (unstable)
|
|
13767
14222
|
* @deprecated
|
|
13768
|
-
|
|
13769
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14223
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
|
|
13770
14224
|
*
|
|
13771
14225
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
13772
14226
|
*
|
|
@@ -13836,8 +14290,7 @@ export interface operations {
|
|
|
13836
14290
|
/**
|
|
13837
14291
|
* Get repository analytics
|
|
13838
14292
|
* @deprecated
|
|
13839
|
-
|
|
13840
|
-
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
14293
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
|
|
13841
14294
|
*
|
|
13842
14295
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
13843
14296
|
*
|