@socketsecurity/sdk 1.8.0 → 1.8.1
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/package.json +19 -19
- package/types/api.d.ts +132 -111
- package/dist/constants.d.ts +0 -5
- package/dist/constants.d.ts.map +0 -1
- package/dist/constants.js +0 -128
- package/dist/constants.js.map +0 -1
- package/dist/file-upload.d.ts +0 -22
- package/dist/file-upload.d.ts.map +0 -1
- package/dist/file-upload.js +0 -152
- package/dist/file-upload.js.map +0 -1
- package/dist/http-client.d.ts +0 -79
- package/dist/http-client.d.ts.map +0 -1
- package/dist/http-client.js +0 -262
- package/dist/http-client.js.map +0 -1
- package/dist/index.d.ts +0 -15
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -53
- package/dist/index.js.map +0 -1
- package/dist/quota-utils.d.ts +0 -52
- package/dist/quota-utils.d.ts.map +0 -1
- package/dist/quota-utils.js +0 -150
- package/dist/quota-utils.js.map +0 -1
- package/dist/socket-sdk-class.d.ts +0 -421
- package/dist/socket-sdk-class.d.ts.map +0 -1
- package/dist/socket-sdk-class.js +0 -1342
- package/dist/socket-sdk-class.js.map +0 -1
- package/dist/types.d.ts +0 -151
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -4
- package/dist/types.js.map +0 -1
- package/dist/user-agent.d.ts +0 -14
- package/dist/user-agent.d.ts.map +0 -1
- package/dist/user-agent.js +0 -18
- package/dist/user-agent.js.map +0 -1
- package/dist/utils.d.ts +0 -28
- package/dist/utils.d.ts.map +0 -1
- package/dist/utils.js +0 -94
- package/dist/utils.js.map +0 -1
package/types/api.d.ts
CHANGED
|
@@ -15,8 +15,10 @@ export interface paths {
|
|
|
15
15
|
*
|
|
16
16
|
* More information on purl and CycloneDX:
|
|
17
17
|
*
|
|
18
|
-
|
|
19
|
-
* - [
|
|
18
|
+
//github.com/package-url/purl-spec)
|
|
19
|
+
* - [`purl` Spec](https:
|
|
20
|
+
//cyclonedx.org/specification/overview/#components)
|
|
21
|
+
* - [CycloneDX Spec](https:
|
|
20
22
|
*
|
|
21
23
|
* This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
|
|
22
24
|
* Actively running analysis will be returned when available on subsequent runs.
|
|
@@ -310,8 +312,7 @@ export interface paths {
|
|
|
310
312
|
'/orgs/{org_slug}/diff-scans/from-repo/{repo_slug}': {
|
|
311
313
|
/**
|
|
312
314
|
* Create diff scan from repository HEAD full-scan
|
|
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
|
|
315
|
+
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
|
|
315
316
|
* the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
|
|
316
317
|
*
|
|
317
318
|
* The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
|
|
@@ -593,7 +594,8 @@ export interface paths {
|
|
|
593
594
|
/**
|
|
594
595
|
* Get Organization License Policy
|
|
595
596
|
* @deprecated
|
|
596
|
-
|
|
597
|
+
//docs.socket.dev/reference/viewlicensepolicy) instead.
|
|
598
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
597
599
|
*
|
|
598
600
|
* Retrieve the license policy of an organization.
|
|
599
601
|
*
|
|
@@ -605,8 +607,7 @@ export interface paths {
|
|
|
605
607
|
get: operations['getOrgLicensePolicy']
|
|
606
608
|
/**
|
|
607
609
|
* Update License Policy
|
|
608
|
-
* @description Set the organization's license policy
|
|
609
|
-
*
|
|
610
|
+
* @description Set the organization's license policy*
|
|
610
611
|
* ## License policy schema
|
|
611
612
|
*
|
|
612
613
|
* ```json
|
|
@@ -641,13 +642,13 @@ export interface paths {
|
|
|
641
642
|
* 'commercial',
|
|
642
643
|
* 'patent'
|
|
643
644
|
*
|
|
644
|
-
|
|
645
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
646
|
+
* Users can learn more about [copyleft tiers](https:
|
|
645
647
|
*
|
|
646
648
|
*
|
|
647
649
|
* ## PURLs
|
|
648
650
|
*
|
|
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
|
-
*
|
|
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.*
|
|
651
652
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
652
653
|
*
|
|
653
654
|
* ### Examples:
|
|
@@ -672,8 +673,7 @@ export interface paths {
|
|
|
672
673
|
'/orgs/{org_slug}/settings/license-policy/view': {
|
|
673
674
|
/**
|
|
674
675
|
* Get License Policy (Beta)
|
|
675
|
-
* @description Returns an organization's license policy
|
|
676
|
-
*
|
|
676
|
+
* @description Returns an organization's license policy*
|
|
677
677
|
* This endpoint consumes 1 unit of your quota.
|
|
678
678
|
*
|
|
679
679
|
* This endpoint requires the following org token scopes:
|
|
@@ -870,11 +870,13 @@ export interface paths {
|
|
|
870
870
|
/**
|
|
871
871
|
* Get Threat Feed Items (Deprecated)
|
|
872
872
|
* @deprecated
|
|
873
|
-
|
|
873
|
+
//docs.socket.dev/reference/getorgthreatfeeditems) instead.
|
|
874
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
874
875
|
*
|
|
875
876
|
* Paginated list of threat feed items.
|
|
876
877
|
*
|
|
877
|
-
|
|
878
|
+
//socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
879
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
878
880
|
*
|
|
879
881
|
* This endpoint consumes 1 unit of your quota.
|
|
880
882
|
*
|
|
@@ -888,7 +890,8 @@ export interface paths {
|
|
|
888
890
|
* Get Threat Feed Items (Beta)
|
|
889
891
|
* @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.
|
|
890
892
|
*
|
|
891
|
-
|
|
893
|
+
//socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
894
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
892
895
|
*
|
|
893
896
|
* This endpoint consumes 1 unit of your quota.
|
|
894
897
|
*
|
|
@@ -983,13 +986,13 @@ export interface paths {
|
|
|
983
986
|
* 'commercial',
|
|
984
987
|
* 'patent'
|
|
985
988
|
*
|
|
986
|
-
|
|
989
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
990
|
+
* Users can learn more about [copyleft tiers](https:
|
|
987
991
|
*
|
|
988
992
|
*
|
|
989
993
|
* ## PURLs
|
|
990
994
|
*
|
|
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
|
-
*
|
|
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.*
|
|
993
996
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
994
997
|
*
|
|
995
998
|
* ### Examples:
|
|
@@ -1016,10 +1019,10 @@ export interface paths {
|
|
|
1016
1019
|
/**
|
|
1017
1020
|
* Saturate License Policy (Legacy)
|
|
1018
1021
|
* @deprecated
|
|
1019
|
-
|
|
1022
|
+
//docs.socket.dev/reference/updateorglicensepolicy) instead.
|
|
1023
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1020
1024
|
*
|
|
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
|
|
1025
|
+
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed* license data. For example, the saturated form of a license allow list which only specifies that
|
|
1023
1026
|
* licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
|
|
1024
1027
|
*
|
|
1025
1028
|
* ```json
|
|
@@ -1075,7 +1078,8 @@ export interface paths {
|
|
|
1075
1078
|
* PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
|
|
1076
1079
|
* CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
|
|
1077
1080
|
*
|
|
1078
|
-
|
|
1081
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
1082
|
+
* readers can learn more about [copyleft tiers](https:
|
|
1079
1083
|
*
|
|
1080
1084
|
* ### Example request bodies:
|
|
1081
1085
|
* ```json
|
|
@@ -1117,7 +1121,8 @@ export interface paths {
|
|
|
1117
1121
|
* ## Return value
|
|
1118
1122
|
*
|
|
1119
1123
|
* ```json
|
|
1120
|
-
|
|
1124
|
+
// Response schema:
|
|
1125
|
+
*
|
|
1121
1126
|
* Array<{
|
|
1122
1127
|
* licenseId: string,
|
|
1123
1128
|
* name?: string,
|
|
@@ -1127,7 +1132,8 @@ export interface paths {
|
|
|
1127
1132
|
* text?: string
|
|
1128
1133
|
* }>
|
|
1129
1134
|
*
|
|
1130
|
-
|
|
1135
|
+
// Example response:
|
|
1136
|
+
*
|
|
1131
1137
|
* [
|
|
1132
1138
|
* {
|
|
1133
1139
|
* "licenseId": "Apache-2.0",
|
|
@@ -1187,13 +1193,13 @@ export interface paths {
|
|
|
1187
1193
|
* 'commercial',
|
|
1188
1194
|
* 'patent'
|
|
1189
1195
|
*
|
|
1190
|
-
|
|
1196
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
1197
|
+
* Users can learn more about [copyleft tiers](https:
|
|
1191
1198
|
*
|
|
1192
1199
|
*
|
|
1193
1200
|
* ## PURLs
|
|
1194
1201
|
*
|
|
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
|
-
*
|
|
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.*
|
|
1197
1203
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
1198
1204
|
*
|
|
1199
1205
|
* ### Examples:
|
|
@@ -1264,7 +1270,8 @@ export interface paths {
|
|
|
1264
1270
|
/**
|
|
1265
1271
|
* Calculate settings
|
|
1266
1272
|
* @deprecated
|
|
1267
|
-
|
|
1273
|
+
//docs.socket.dev/reference/updateorgsecuritypolicy) instead.
|
|
1274
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1268
1275
|
*
|
|
1269
1276
|
* Get current settings for the requested organizations and default settings to allow deferrals.
|
|
1270
1277
|
*
|
|
@@ -1279,7 +1286,8 @@ export interface paths {
|
|
|
1279
1286
|
/**
|
|
1280
1287
|
* Get supported files for report
|
|
1281
1288
|
* @deprecated
|
|
1282
|
-
|
|
1289
|
+
//docs.socket.dev/reference/getsupportedfiles) instead.
|
|
1290
|
+
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
|
|
1283
1291
|
*
|
|
1284
1292
|
* This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
|
|
1285
1293
|
*
|
|
@@ -1299,7 +1307,8 @@ export interface paths {
|
|
|
1299
1307
|
/**
|
|
1300
1308
|
* Delete a report
|
|
1301
1309
|
* @deprecated
|
|
1302
|
-
|
|
1310
|
+
//docs.socket.dev/reference) instead.
|
|
1311
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1303
1312
|
*
|
|
1304
1313
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
|
|
1305
1314
|
*
|
|
@@ -1314,7 +1323,8 @@ export interface paths {
|
|
|
1314
1323
|
/**
|
|
1315
1324
|
* Get list of reports
|
|
1316
1325
|
* @deprecated
|
|
1317
|
-
|
|
1326
|
+
//docs.socket.dev/reference) instead.
|
|
1327
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1318
1328
|
*
|
|
1319
1329
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
|
|
1320
1330
|
*
|
|
@@ -1329,7 +1339,8 @@ export interface paths {
|
|
|
1329
1339
|
/**
|
|
1330
1340
|
* Create a report
|
|
1331
1341
|
* @deprecated
|
|
1332
|
-
|
|
1342
|
+
//docs.socket.dev/reference/createorgfullscan) instead.
|
|
1343
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1333
1344
|
*
|
|
1334
1345
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
|
|
1335
1346
|
*
|
|
@@ -1351,7 +1362,8 @@ export interface paths {
|
|
|
1351
1362
|
/**
|
|
1352
1363
|
* View a report
|
|
1353
1364
|
* @deprecated
|
|
1354
|
-
|
|
1365
|
+
//docs.socket.dev/reference/getorgfullscan) instead.
|
|
1366
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1355
1367
|
*
|
|
1356
1368
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
|
|
1357
1369
|
*
|
|
@@ -1366,7 +1378,8 @@ export interface paths {
|
|
|
1366
1378
|
/**
|
|
1367
1379
|
* List GitHub repositories
|
|
1368
1380
|
* @deprecated
|
|
1369
|
-
|
|
1381
|
+
//docs.socket.dev/reference/getorgrepolist) instead.
|
|
1382
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1370
1383
|
*
|
|
1371
1384
|
* Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
|
|
1372
1385
|
*
|
|
@@ -1381,12 +1394,14 @@ export interface paths {
|
|
|
1381
1394
|
/**
|
|
1382
1395
|
* Get issues by package
|
|
1383
1396
|
* @deprecated
|
|
1384
|
-
|
|
1397
|
+
//docs.socket.dev/reference) instead.
|
|
1398
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1385
1399
|
*
|
|
1386
1400
|
* Get all the issues related with a particular npm package version.
|
|
1387
1401
|
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
|
|
1388
1402
|
*
|
|
1389
|
-
|
|
1403
|
+
//socket.dev/alerts) the full list of issues.
|
|
1404
|
+
* You can [see here](https:
|
|
1390
1405
|
*
|
|
1391
1406
|
* This endpoint consumes 1 unit of your quota.
|
|
1392
1407
|
*
|
|
@@ -1399,7 +1414,8 @@ export interface paths {
|
|
|
1399
1414
|
/**
|
|
1400
1415
|
* Get score by package
|
|
1401
1416
|
* @deprecated
|
|
1402
|
-
|
|
1417
|
+
//docs.socket.dev/reference/batchpackagefetch) instead.
|
|
1418
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1403
1419
|
*
|
|
1404
1420
|
* Get all the scores and metrics by category that are used to evaluate the package version.
|
|
1405
1421
|
*
|
|
@@ -1414,20 +1430,17 @@ export interface paths {
|
|
|
1414
1430
|
* - quality: Score factors relating to code quality (0-1)
|
|
1415
1431
|
* - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
|
|
1416
1432
|
* - linesOfCode: The number of lines of code in the package. Lower count contributes 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)
|
|
1433
|
+
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.* - maintenance: Score factors relating to package maintenance (0-1)
|
|
1419
1434
|
* - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
|
|
1420
1435
|
* - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
|
|
1421
1436
|
* - versionCount: The total number of versions released. Higher count contributes to a higher score.
|
|
1422
1437
|
* - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
|
|
1423
1438
|
* - vulnerability: Score factors relating to package vulnerabilities (0-1)
|
|
1424
1439
|
* - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute 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.
|
|
1440
|
+
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
|
|
1427
1441
|
* - license: Score factors relating to package licensing (0-1)
|
|
1428
1442
|
* - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute 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.
|
|
1443
|
+
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.* - miscellaneous: Miscellaneous metadata about the package version.
|
|
1431
1444
|
* - versionAuthorName/Email: The name and email of the version author.
|
|
1432
1445
|
* - fileCount: The number of files in the package.
|
|
1433
1446
|
* - byteCount: The total size in bytes of the package.
|
|
@@ -1444,7 +1457,8 @@ export interface paths {
|
|
|
1444
1457
|
/**
|
|
1445
1458
|
* Get organization analytics (unstable)
|
|
1446
1459
|
* @deprecated
|
|
1447
|
-
|
|
1460
|
+
//docs.socket.dev/reference/historicalalertstrend) instead.
|
|
1461
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1448
1462
|
*
|
|
1449
1463
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
1450
1464
|
*
|
|
@@ -1461,7 +1475,8 @@ export interface paths {
|
|
|
1461
1475
|
/**
|
|
1462
1476
|
* Get repository analytics
|
|
1463
1477
|
* @deprecated
|
|
1464
|
-
|
|
1478
|
+
//docs.socket.dev/reference/historicalalertstrend) instead.
|
|
1479
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
1465
1480
|
*
|
|
1466
1481
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
1467
1482
|
*
|
|
@@ -1894,8 +1909,7 @@ export interface components {
|
|
|
1894
1909
|
*/
|
|
1895
1910
|
subpath?: string
|
|
1896
1911
|
/**
|
|
1897
|
-
* @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version
|
|
1898
|
-
* @default
|
|
1912
|
+
* @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version* @default
|
|
1899
1913
|
*/
|
|
1900
1914
|
release?: string
|
|
1901
1915
|
}
|
|
@@ -4316,7 +4330,8 @@ export interface components {
|
|
|
4316
4330
|
headers: {
|
|
4317
4331
|
/**
|
|
4318
4332
|
* @description Retry contacting the endpoint *at least* after seconds.
|
|
4319
|
-
|
|
4333
|
+
//tools.ietf.org/html/rfc7231#section-7.1.3
|
|
4334
|
+
* See https:
|
|
4320
4335
|
*/
|
|
4321
4336
|
'Retry-After'?: number
|
|
4322
4337
|
}
|
|
@@ -4379,8 +4394,10 @@ export interface operations {
|
|
|
4379
4394
|
*
|
|
4380
4395
|
* More information on purl and CycloneDX:
|
|
4381
4396
|
*
|
|
4382
|
-
|
|
4383
|
-
* - [
|
|
4397
|
+
//github.com/package-url/purl-spec)
|
|
4398
|
+
* - [`purl` Spec](https:
|
|
4399
|
+
//cyclonedx.org/specification/overview/#components)
|
|
4400
|
+
* - [CycloneDX Spec](https:
|
|
4384
4401
|
*
|
|
4385
4402
|
* This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
|
|
4386
4403
|
* Actively running analysis will be returned when available on subsequent runs.
|
|
@@ -5224,8 +5241,7 @@ export interface operations {
|
|
|
5224
5241
|
query?: {
|
|
5225
5242
|
/**
|
|
5226
5243
|
* @description The person(s) who created the BOM.
|
|
5227
|
-
* Set this value if you're intending the modify the BOM and claim authorship
|
|
5228
|
-
*/
|
|
5244
|
+
* Set this value if you're intending the modify the BOM and claim authorship.*/
|
|
5229
5245
|
author?: string
|
|
5230
5246
|
/** @description Dependency track project group */
|
|
5231
5247
|
project_group?: string
|
|
@@ -5286,8 +5302,7 @@ export interface operations {
|
|
|
5286
5302
|
query?: {
|
|
5287
5303
|
/**
|
|
5288
5304
|
* @description The person(s) who created the BOM.
|
|
5289
|
-
* Set this value if you're intending the modify the BOM and claim authorship
|
|
5290
|
-
*/
|
|
5305
|
+
* Set this value if you're intending the modify the BOM and claim authorship.*/
|
|
5291
5306
|
author?: string
|
|
5292
5307
|
/** @description Dependency track project group */
|
|
5293
5308
|
project_group?: string
|
|
@@ -5681,8 +5696,7 @@ export interface operations {
|
|
|
5681
5696
|
}
|
|
5682
5697
|
/**
|
|
5683
5698
|
* Create diff scan from repository HEAD full-scan
|
|
5684
|
-
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.
|
|
5685
|
-
* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
|
|
5699
|
+
* @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
|
|
5686
5700
|
* the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
|
|
5687
5701
|
*
|
|
5688
5702
|
* The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
|
|
@@ -10968,7 +10982,8 @@ export interface operations {
|
|
|
10968
10982
|
/**
|
|
10969
10983
|
* Get Organization License Policy
|
|
10970
10984
|
* @deprecated
|
|
10971
|
-
|
|
10985
|
+
//docs.socket.dev/reference/viewlicensepolicy) instead.
|
|
10986
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
10972
10987
|
*
|
|
10973
10988
|
* Retrieve the license policy of an organization.
|
|
10974
10989
|
*
|
|
@@ -11000,8 +11015,7 @@ export interface operations {
|
|
|
11000
11015
|
}
|
|
11001
11016
|
/**
|
|
11002
11017
|
* Update License Policy
|
|
11003
|
-
* @description Set the organization's license policy
|
|
11004
|
-
*
|
|
11018
|
+
* @description Set the organization's license policy*
|
|
11005
11019
|
* ## License policy schema
|
|
11006
11020
|
*
|
|
11007
11021
|
* ```json
|
|
@@ -11036,13 +11050,13 @@ export interface operations {
|
|
|
11036
11050
|
* 'commercial',
|
|
11037
11051
|
* 'patent'
|
|
11038
11052
|
*
|
|
11039
|
-
|
|
11053
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
11054
|
+
* Users can learn more about [copyleft tiers](https:
|
|
11040
11055
|
*
|
|
11041
11056
|
*
|
|
11042
11057
|
* ## PURLs
|
|
11043
11058
|
*
|
|
11044
|
-
* 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
|
|
11045
|
-
*
|
|
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.*
|
|
11046
11060
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
11047
11061
|
*
|
|
11048
11062
|
* ### Examples:
|
|
@@ -11094,8 +11108,7 @@ export interface operations {
|
|
|
11094
11108
|
}
|
|
11095
11109
|
/**
|
|
11096
11110
|
* Get License Policy (Beta)
|
|
11097
|
-
* @description Returns an organization's license policy
|
|
11098
|
-
*
|
|
11111
|
+
* @description Returns an organization's license policy*
|
|
11099
11112
|
* This endpoint consumes 1 unit of your quota.
|
|
11100
11113
|
*
|
|
11101
11114
|
* This endpoint requires the following org token scopes:
|
|
@@ -11244,10 +11257,8 @@ export interface operations {
|
|
|
11244
11257
|
'filters.artifactType'?: string
|
|
11245
11258
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11246
11259
|
'filters.artifactType.notIn'?: string
|
|
11247
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11248
|
-
'filters.alertAction'?: string
|
|
11249
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11250
|
-
'filters.alertAction.notIn'?: string
|
|
11260
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */ 'filters.alertAction'?: string
|
|
11261
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ 'filters.alertAction.notIn'?: string
|
|
11251
11262
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
|
|
11252
11263
|
'filters.alertActionSourceType'?: string
|
|
11253
11264
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
@@ -11417,8 +11428,7 @@ export interface operations {
|
|
|
11417
11428
|
artifactName?: string[]
|
|
11418
11429
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11419
11430
|
artifactType?: string[]
|
|
11420
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11421
|
-
alertAction?: string[]
|
|
11431
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ alertAction?: string[]
|
|
11422
11432
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
11423
11433
|
alertActionSourceType?: string[]
|
|
11424
11434
|
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
@@ -11496,10 +11506,8 @@ export interface operations {
|
|
|
11496
11506
|
'filters.artifactType'?: string
|
|
11497
11507
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11498
11508
|
'filters.artifactType.notIn'?: string
|
|
11499
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
11500
|
-
'filters.alertAction'?: string
|
|
11501
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11502
|
-
'filters.alertAction.notIn'?: string
|
|
11509
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */ 'filters.alertAction'?: string
|
|
11510
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ 'filters.alertAction.notIn'?: string
|
|
11503
11511
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
|
|
11504
11512
|
'filters.alertActionSourceType'?: string
|
|
11505
11513
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
@@ -11585,8 +11593,7 @@ export interface operations {
|
|
|
11585
11593
|
artifactName?: string[]
|
|
11586
11594
|
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
11587
11595
|
artifactType?: string[]
|
|
11588
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
11589
|
-
alertAction?: string[]
|
|
11596
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ alertAction?: string[]
|
|
11590
11597
|
/** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
|
|
11591
11598
|
alertActionSourceType?: string[]
|
|
11592
11599
|
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
@@ -12601,11 +12608,13 @@ export interface operations {
|
|
|
12601
12608
|
/**
|
|
12602
12609
|
* Get Threat Feed Items (Deprecated)
|
|
12603
12610
|
* @deprecated
|
|
12604
|
-
|
|
12611
|
+
//docs.socket.dev/reference/getorgthreatfeeditems) instead.
|
|
12612
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
12605
12613
|
*
|
|
12606
12614
|
* Paginated list of threat feed items.
|
|
12607
12615
|
*
|
|
12608
|
-
|
|
12616
|
+
//socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
12617
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
12609
12618
|
*
|
|
12610
12619
|
* This endpoint consumes 1 unit of your quota.
|
|
12611
12620
|
*
|
|
@@ -12705,7 +12714,8 @@ export interface operations {
|
|
|
12705
12714
|
* Get Threat Feed Items (Beta)
|
|
12706
12715
|
* @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.
|
|
12707
12716
|
*
|
|
12708
|
-
|
|
12717
|
+
//socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
|
|
12718
|
+
* This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
|
|
12709
12719
|
*
|
|
12710
12720
|
* This endpoint consumes 1 unit of your quota.
|
|
12711
12721
|
*
|
|
@@ -12892,13 +12902,13 @@ export interface operations {
|
|
|
12892
12902
|
* 'commercial',
|
|
12893
12903
|
* 'patent'
|
|
12894
12904
|
*
|
|
12895
|
-
|
|
12905
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
12906
|
+
* Users can learn more about [copyleft tiers](https:
|
|
12896
12907
|
*
|
|
12897
12908
|
*
|
|
12898
12909
|
* ## PURLs
|
|
12899
12910
|
*
|
|
12900
|
-
* 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
|
|
12901
|
-
*
|
|
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.*
|
|
12902
12912
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
12903
12913
|
*
|
|
12904
12914
|
* ### Examples:
|
|
@@ -12953,10 +12963,10 @@ export interface operations {
|
|
|
12953
12963
|
/**
|
|
12954
12964
|
* Saturate License Policy (Legacy)
|
|
12955
12965
|
* @deprecated
|
|
12956
|
-
|
|
12966
|
+
//docs.socket.dev/reference/updateorglicensepolicy) instead.
|
|
12967
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
12957
12968
|
*
|
|
12958
|
-
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
|
|
12959
|
-
* license data. For example, the saturated form of a license allow list which only specifies that
|
|
12969
|
+
* Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed* license data. For example, the saturated form of a license allow list which only specifies that
|
|
12960
12970
|
* licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
|
|
12961
12971
|
*
|
|
12962
12972
|
* ```json
|
|
@@ -13012,7 +13022,8 @@ export interface operations {
|
|
|
13012
13022
|
* PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
|
|
13013
13023
|
* CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
|
|
13014
13024
|
*
|
|
13015
|
-
|
|
13025
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
13026
|
+
* readers can learn more about [copyleft tiers](https:
|
|
13016
13027
|
*
|
|
13017
13028
|
* ### Example request bodies:
|
|
13018
13029
|
* ```json
|
|
@@ -13083,7 +13094,8 @@ export interface operations {
|
|
|
13083
13094
|
* ## Return value
|
|
13084
13095
|
*
|
|
13085
13096
|
* ```json
|
|
13086
|
-
|
|
13097
|
+
// Response schema:
|
|
13098
|
+
*
|
|
13087
13099
|
* Array<{
|
|
13088
13100
|
* licenseId: string,
|
|
13089
13101
|
* name?: string,
|
|
@@ -13093,7 +13105,8 @@ export interface operations {
|
|
|
13093
13105
|
* text?: string
|
|
13094
13106
|
* }>
|
|
13095
13107
|
*
|
|
13096
|
-
|
|
13108
|
+
// Example response:
|
|
13109
|
+
*
|
|
13097
13110
|
* [
|
|
13098
13111
|
* {
|
|
13099
13112
|
* "licenseId": "Apache-2.0",
|
|
@@ -13153,13 +13166,13 @@ export interface operations {
|
|
|
13153
13166
|
* 'commercial',
|
|
13154
13167
|
* 'patent'
|
|
13155
13168
|
*
|
|
13156
|
-
|
|
13169
|
+
//blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
|
|
13170
|
+
* Users can learn more about [copyleft tiers](https:
|
|
13157
13171
|
*
|
|
13158
13172
|
*
|
|
13159
13173
|
* ## PURLs
|
|
13160
13174
|
*
|
|
13161
|
-
* 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
|
|
13162
|
-
*
|
|
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.*
|
|
13163
13176
|
* purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
|
|
13164
13177
|
*
|
|
13165
13178
|
* ### Examples:
|
|
@@ -13328,7 +13341,8 @@ export interface operations {
|
|
|
13328
13341
|
/**
|
|
13329
13342
|
* Calculate settings
|
|
13330
13343
|
* @deprecated
|
|
13331
|
-
|
|
13344
|
+
//docs.socket.dev/reference/updateorgsecuritypolicy) instead.
|
|
13345
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13332
13346
|
*
|
|
13333
13347
|
* Get current settings for the requested organizations and default settings to allow deferrals.
|
|
13334
13348
|
*
|
|
@@ -13348,8 +13362,7 @@ export interface operations {
|
|
|
13348
13362
|
}
|
|
13349
13363
|
}
|
|
13350
13364
|
responses: {
|
|
13351
|
-
/** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */
|
|
13352
|
-
200: {
|
|
13365
|
+
/** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */ 200: {
|
|
13353
13366
|
content: {
|
|
13354
13367
|
'application/json': {
|
|
13355
13368
|
defaults: {
|
|
@@ -13386,7 +13399,8 @@ export interface operations {
|
|
|
13386
13399
|
/**
|
|
13387
13400
|
* Get supported files for report
|
|
13388
13401
|
* @deprecated
|
|
13389
|
-
|
|
13402
|
+
//docs.socket.dev/reference/getsupportedfiles) instead.
|
|
13403
|
+
* @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
|
|
13390
13404
|
*
|
|
13391
13405
|
* This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
|
|
13392
13406
|
*
|
|
@@ -13422,7 +13436,8 @@ export interface operations {
|
|
|
13422
13436
|
/**
|
|
13423
13437
|
* Delete a report
|
|
13424
13438
|
* @deprecated
|
|
13425
|
-
|
|
13439
|
+
//docs.socket.dev/reference) instead.
|
|
13440
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13426
13441
|
*
|
|
13427
13442
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
|
|
13428
13443
|
*
|
|
@@ -13457,7 +13472,8 @@ export interface operations {
|
|
|
13457
13472
|
/**
|
|
13458
13473
|
* Get list of reports
|
|
13459
13474
|
* @deprecated
|
|
13460
|
-
|
|
13475
|
+
//docs.socket.dev/reference) instead.
|
|
13476
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13461
13477
|
*
|
|
13462
13478
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
|
|
13463
13479
|
*
|
|
@@ -13509,7 +13525,8 @@ export interface operations {
|
|
|
13509
13525
|
/**
|
|
13510
13526
|
* Create a report
|
|
13511
13527
|
* @deprecated
|
|
13512
|
-
|
|
13528
|
+
//docs.socket.dev/reference/createorgfullscan) instead.
|
|
13529
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13513
13530
|
*
|
|
13514
13531
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
|
|
13515
13532
|
*
|
|
@@ -13557,7 +13574,8 @@ export interface operations {
|
|
|
13557
13574
|
/**
|
|
13558
13575
|
* View a report
|
|
13559
13576
|
* @deprecated
|
|
13560
|
-
|
|
13577
|
+
//docs.socket.dev/reference/getorgfullscan) instead.
|
|
13578
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13561
13579
|
*
|
|
13562
13580
|
* Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
|
|
13563
13581
|
*
|
|
@@ -13590,7 +13608,8 @@ export interface operations {
|
|
|
13590
13608
|
/**
|
|
13591
13609
|
* List GitHub repositories
|
|
13592
13610
|
* @deprecated
|
|
13593
|
-
|
|
13611
|
+
//docs.socket.dev/reference/getorgrepolist) instead.
|
|
13612
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13594
13613
|
*
|
|
13595
13614
|
* Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
|
|
13596
13615
|
*
|
|
@@ -13647,12 +13666,14 @@ export interface operations {
|
|
|
13647
13666
|
/**
|
|
13648
13667
|
* Get issues by package
|
|
13649
13668
|
* @deprecated
|
|
13650
|
-
|
|
13669
|
+
//docs.socket.dev/reference) instead.
|
|
13670
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13651
13671
|
*
|
|
13652
13672
|
* Get all the issues related with a particular npm package version.
|
|
13653
13673
|
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
|
|
13654
13674
|
*
|
|
13655
|
-
|
|
13675
|
+
//socket.dev/alerts) the full list of issues.
|
|
13676
|
+
* You can [see here](https:
|
|
13656
13677
|
*
|
|
13657
13678
|
* This endpoint consumes 1 unit of your quota.
|
|
13658
13679
|
*
|
|
@@ -13683,7 +13704,8 @@ export interface operations {
|
|
|
13683
13704
|
/**
|
|
13684
13705
|
* Get score by package
|
|
13685
13706
|
* @deprecated
|
|
13686
|
-
|
|
13707
|
+
//docs.socket.dev/reference/batchpackagefetch) instead.
|
|
13708
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13687
13709
|
*
|
|
13688
13710
|
* Get all the scores and metrics by category that are used to evaluate the package version.
|
|
13689
13711
|
*
|
|
@@ -13698,20 +13720,17 @@ export interface operations {
|
|
|
13698
13720
|
* - quality: Score factors relating to code quality (0-1)
|
|
13699
13721
|
* - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
|
|
13700
13722
|
* - linesOfCode: The number of lines of code in the package. Lower count contributes to a higher score.
|
|
13701
|
-
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score
|
|
13702
|
-
* - maintenance: Score factors relating to package maintenance (0-1)
|
|
13723
|
+
* - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.* - maintenance: Score factors relating to package maintenance (0-1)
|
|
13703
13724
|
* - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
|
|
13704
13725
|
* - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
|
|
13705
13726
|
* - versionCount: The total number of versions released. Higher count contributes to a higher score.
|
|
13706
13727
|
* - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
|
|
13707
13728
|
* - vulnerability: Score factors relating to package vulnerabilities (0-1)
|
|
13708
13729
|
* - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute to a higher score.
|
|
13709
|
-
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.
|
|
13710
|
-
* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
|
|
13730
|
+
* - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
|
|
13711
13731
|
* - license: Score factors relating to package licensing (0-1)
|
|
13712
13732
|
* - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute to a higher score.
|
|
13713
|
-
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.
|
|
13714
|
-
* - miscellaneous: Miscellaneous metadata about the package version.
|
|
13733
|
+
* - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.* - miscellaneous: Miscellaneous metadata about the package version.
|
|
13715
13734
|
* - versionAuthorName/Email: The name and email of the version author.
|
|
13716
13735
|
* - fileCount: The number of files in the package.
|
|
13717
13736
|
* - byteCount: The total size in bytes of the package.
|
|
@@ -13746,7 +13765,8 @@ export interface operations {
|
|
|
13746
13765
|
/**
|
|
13747
13766
|
* Get organization analytics (unstable)
|
|
13748
13767
|
* @deprecated
|
|
13749
|
-
|
|
13768
|
+
//docs.socket.dev/reference/historicalalertstrend) instead.
|
|
13769
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13750
13770
|
*
|
|
13751
13771
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
13752
13772
|
*
|
|
@@ -13816,7 +13836,8 @@ export interface operations {
|
|
|
13816
13836
|
/**
|
|
13817
13837
|
* Get repository analytics
|
|
13818
13838
|
* @deprecated
|
|
13819
|
-
|
|
13839
|
+
//docs.socket.dev/reference/historicalalertstrend) instead.
|
|
13840
|
+
* @description **This endpoint is deprecated.** Use the [successor version](https:
|
|
13820
13841
|
*
|
|
13821
13842
|
* Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
|
|
13822
13843
|
*
|