7
7
export interface paths {
8
8
"/npm/{package}/{version}/issues" : {
9
9
/**
10
- * Get issues by package
10
+ * Get issues by package
11
11
* @description Get all the issues related with a particular npm package version.
12
12
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
13
- *
13
+ *
14
14
* You can [see here](https://socket.dev/npm/issue) the full list of issues.
15
- *
15
+ *
16
16
* This endpoint consumes 1 unit of your quota.
17
17
*/
18
18
get : operations [ "getIssuesByNPMPackage" ] ;
19
19
} ;
20
20
"/npm/{package}/{version}/score" : {
21
21
/**
22
- * Get score by package
22
+ * Get score by package
23
23
* @description Get all the scores and metrics by category that are used to evaluate the package version.
24
- *
24
+ *
25
25
* This endpoint consumes 1 unit of your quota.
26
26
*/
27
27
get : operations [ "getScoreByNPMPackage" ] ;
28
28
} ;
29
29
"/report/delete/{id}" : {
30
30
/**
31
- * Delete a report
31
+ * Delete a report
32
32
* @description Delete a specific project report.
33
- *
33
+ *
34
34
* This endpoint consumes 10 units of your quota.
35
35
*/
36
36
delete : operations [ "deleteReport" ] ;
37
37
} ;
38
38
"/report/list" : {
39
39
/**
40
- * Get list of reports
40
+ * Get list of reports
41
41
* @description Get all your project reports.
42
- *
42
+ *
43
43
* This endpoint consumes 10 units of your quota.
44
44
*/
45
45
get : operations [ "getReportList" ] ;
46
46
} ;
47
47
"/report/upload" : {
48
48
/**
49
- * Create a report
49
+ * Create a report
50
50
* @description Upload a lockfile to get your project analyzed by Socket.
51
51
* You can upload multiple lockfiles in the same request, but each filename must be unique.
52
- *
52
+ *
53
53
* The name of the file must be in the supported list.
54
- *
54
+ *
55
55
* For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
56
- *
56
+ *
57
57
* This endpoint consumes 100 units of your quota.
58
58
*/
59
59
put : operations [ "createReport" ] ;
60
60
} ;
61
61
"/report/view/{id}" : {
62
62
/**
63
- * View a report
63
+ * View a report
64
64
* @description Get all the issues, packages, and scores related to an specific project report.
65
- *
65
+ *
66
66
* This endpoint consumes 10 units of your quota.
67
67
*/
68
68
get : operations [ "getReport" ] ;
69
69
} ;
70
70
"/report/supported" : {
71
71
/**
72
- * Get supported files for report
72
+ * Get supported files for report
73
73
* @description Get a list of supported files for project report generation.
74
74
* Files are categorized first by environment (e.g. NPM or PyPI), then by name.
75
- *
75
+ *
76
76
* Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
77
77
* Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
78
- *
78
+ *
79
79
* This endpoint consumes 0 units of your quota.
80
80
*/
81
81
get : operations [ "getReportSupportedFiles" ] ;
82
82
} ;
83
83
"/openapi" : {
84
84
/**
85
- * Returns the OpenAPI definition
85
+ * Returns the OpenAPI definition
86
86
* @description Retrieve the API specification in an Openapi JSON format.
87
- *
87
+ *
88
88
* This endpoint consumes 0 units of your quota.
89
89
*/
90
90
get : operations [ "getOpenAPI" ] ;
91
91
} ;
92
92
"/quota" : {
93
93
/**
94
- * Get quota
94
+ * Get quota
95
95
* @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
96
- *
96
+ *
97
97
* This endpoint consumes 0 units of your quota.
98
98
*/
99
99
get : operations [ "getQuota" ] ;
100
100
} ;
101
101
"/organizations" : {
102
102
/**
103
- * List organizations
103
+ * List organizations
104
104
* @description Get information on the current organizations associated with the API key.
105
- *
105
+ *
106
106
* This endpoint consumes 0 units of your quota.
107
107
*/
108
108
get : operations [ "getOrganizations" ] ;
109
109
} ;
110
110
"/settings" : {
111
111
/**
112
- * Calculate settings
112
+ * Calculate settings
113
113
* @description Get your current settings the requested organizations and default settings to allow deferrals.
114
- *
114
+ *
115
115
* This endpoint consumes 0 units of your quota.
116
116
*/
117
117
post : operations [ "postSettings" ] ;
118
118
} ;
119
119
"/repo/list" : {
120
120
/**
121
- * Get list of repos and their latest project report
121
+ * Get list of repos and their latest project report
122
122
* @description Get all repositories in an org including their latest project report.
123
- *
123
+ *
124
124
* This endpoint consumes 0 units of your quota.
125
125
*/
126
126
get : operations [ "getRepoList" ] ;
127
127
} ;
128
128
"/dependencies/search" : {
129
129
/**
130
- * Search dependencies
130
+ * Search dependencies
131
131
* @description Search for any dependency that is being used in your organization.
132
- *
132
+ *
133
133
* This endpoint consumes 0 units of your quota.
134
134
*/
135
135
post : operations [ "searchDependencies" ] ;
136
136
} ;
137
137
"/dependencies/upload" : {
138
138
/**
139
- * Create a snapshot of all dependencies from manifest information
139
+ * Create a snapshot of all dependencies from manifest information
140
140
* @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
141
141
* You can upload multiple lockfiles in the same request, but each filename must be unique.
142
- *
142
+ *
143
143
* The name of the file must be in the supported list.
144
- *
144
+ *
145
145
* For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
146
- *
146
+ *
147
147
* This endpoint consumes 100 units of your quota.
148
148
*/
149
149
post : operations [ "createDependenciesSnapshot" ] ;
@@ -1232,6 +1232,7 @@ export interface components {
1232
1232
severity : components [ "schemas" ] [ "SocketIssueSeverity" ] ;
1233
1233
category : components [ "schemas" ] [ "SocketCategory" ] ;
1234
1234
locations : components [ "schemas" ] [ "SocketRefList" ] ;
1235
+ label : string ;
1235
1236
} ;
1236
1237
SocketUsageRef : {
1237
1238
file : components [ "schemas" ] [ "SocketRefFile" ] ;
@@ -1248,12 +1249,12 @@ export interface components {
1248
1249
value : Record < string , never > ;
1249
1250
} ;
1250
1251
/**
1251
- * @default low
1252
+ * @default low
1252
1253
* @enum {string}
1253
1254
*/
1254
1255
SocketIssueSeverity : "low" | "middle" | "high" | "critical" ;
1255
1256
/**
1256
- * @default miscellaneous
1257
+ * @default miscellaneous
1257
1258
* @enum {string}
1258
1259
*/
1259
1260
SocketCategory : "supplyChainRisk" | "quality" | "maintenance" | "vulnerability" | "license" | "miscellaneous" ;
@@ -1430,12 +1431,12 @@ export type external = Record<string, never>;
1430
1431
export interface operations {
1431
1432
1432
1433
/**
1433
- * Get issues by package
1434
+ * Get issues by package
1434
1435
* @description Get all the issues related with a particular npm package version.
1435
1436
* This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
1436
- *
1437
+ *
1437
1438
* You can [see here](https://socket.dev/npm/issue) the full list of issues.
1438
- *
1439
+ *
1439
1440
* This endpoint consumes 1 unit of your quota.
1440
1441
*/
1441
1442
getIssuesByNPMPackage : {
@@ -1460,9 +1461,9 @@ export interface operations {
1460
1461
} ;
1461
1462
} ;
1462
1463
/**
1463
- * Get score by package
1464
+ * Get score by package
1464
1465
* @description Get all the scores and metrics by category that are used to evaluate the package version.
1465
- *
1466
+ *
1466
1467
* This endpoint consumes 1 unit of your quota.
1467
1468
*/
1468
1469
getScoreByNPMPackage : {
@@ -1487,9 +1488,9 @@ export interface operations {
1487
1488
} ;
1488
1489
} ;
1489
1490
/**
1490
- * Delete a report
1491
+ * Delete a report
1491
1492
* @description Delete a specific project report.
1492
- *
1493
+ *
1493
1494
* This endpoint consumes 10 units of your quota.
1494
1495
*/
1495
1496
deleteReport : {
@@ -1516,9 +1517,9 @@ export interface operations {
1516
1517
} ;
1517
1518
} ;
1518
1519
/**
1519
- * Get list of reports
1520
+ * Get list of reports
1520
1521
* @description Get all your project reports.
1521
- *
1522
+ *
1522
1523
* This endpoint consumes 10 units of your quota.
1523
1524
*/
1524
1525
getReportList : {
@@ -1542,14 +1543,14 @@ export interface operations {
1542
1543
} ;
1543
1544
} ;
1544
1545
/**
1545
- * Create a report
1546
+ * Create a report
1546
1547
* @description Upload a lockfile to get your project analyzed by Socket.
1547
1548
* You can upload multiple lockfiles in the same request, but each filename must be unique.
1548
- *
1549
+ *
1549
1550
* The name of the file must be in the supported list.
1550
- *
1551
+ *
1551
1552
* For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
1552
- *
1553
+ *
1553
1554
* This endpoint consumes 100 units of your quota.
1554
1555
*/
1555
1556
createReport : {
@@ -1582,9 +1583,9 @@ export interface operations {
1582
1583
} ;
1583
1584
} ;
1584
1585
/**
1585
- * View a report
1586
+ * View a report
1586
1587
* @description Get all the issues, packages, and scores related to an specific project report.
1587
- *
1588
+ *
1588
1589
* This endpoint consumes 10 units of your quota.
1589
1590
*/
1590
1591
getReport : {
@@ -1608,13 +1609,13 @@ export interface operations {
1608
1609
} ;
1609
1610
} ;
1610
1611
/**
1611
- * Get supported files for report
1612
+ * Get supported files for report
1612
1613
* @description Get a list of supported files for project report generation.
1613
1614
* Files are categorized first by environment (e.g. NPM or PyPI), then by name.
1614
- *
1615
+ *
1615
1616
* Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
1616
1617
* Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
1617
- *
1618
+ *
1618
1619
* This endpoint consumes 0 units of your quota.
1619
1620
*/
1620
1621
getReportSupportedFiles : {
@@ -1637,9 +1638,9 @@ export interface operations {
1637
1638
} ;
1638
1639
} ;
1639
1640
/**
1640
- * Returns the OpenAPI definition
1641
+ * Returns the OpenAPI definition
1641
1642
* @description Retrieve the API specification in an Openapi JSON format.
1642
- *
1643
+ *
1643
1644
* This endpoint consumes 0 units of your quota.
1644
1645
*/
1645
1646
getOpenAPI : {
@@ -1654,9 +1655,9 @@ export interface operations {
1654
1655
} ;
1655
1656
} ;
1656
1657
/**
1657
- * Get quota
1658
+ * Get quota
1658
1659
* @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
1659
- *
1660
+ *
1660
1661
* This endpoint consumes 0 units of your quota.
1661
1662
*/
1662
1663
getQuota : {
@@ -1675,9 +1676,9 @@ export interface operations {
1675
1676
} ;
1676
1677
} ;
1677
1678
/**
1678
- * List organizations
1679
+ * List organizations
1679
1680
* @description Get information on the current organizations associated with the API key.
1680
- *
1681
+ *
1681
1682
* This endpoint consumes 0 units of your quota.
1682
1683
*/
1683
1684
getOrganizations : {
@@ -1706,9 +1707,9 @@ export interface operations {
1706
1707
} ;
1707
1708
} ;
1708
1709
/**
1709
- * Calculate settings
1710
+ * Calculate settings
1710
1711
* @description Get your current settings the requested organizations and default settings to allow deferrals.
1711
- *
1712
+ *
1712
1713
* This endpoint consumes 0 units of your quota.
1713
1714
*/
1714
1715
postSettings : {
@@ -1757,9 +1758,9 @@ export interface operations {
1757
1758
} ;
1758
1759
} ;
1759
1760
/**
1760
- * Get list of repos and their latest project report
1761
+ * Get list of repos and their latest project report
1761
1762
* @description Get all repositories in an org including their latest project report.
1762
- *
1763
+ *
1763
1764
* This endpoint consumes 0 units of your quota.
1764
1765
*/
1765
1766
getRepoList : {
@@ -1803,9 +1804,9 @@ export interface operations {
1803
1804
} ;
1804
1805
} ;
1805
1806
/**
1806
- * Search dependencies
1807
+ * Search dependencies
1807
1808
* @description Search for any dependency that is being used in your organization.
1808
- *
1809
+ *
1809
1810
* This endpoint consumes 0 units of your quota.
1810
1811
*/
1811
1812
searchDependencies : {
@@ -1857,14 +1858,14 @@ export interface operations {
1857
1858
} ;
1858
1859
} ;
1859
1860
/**
1860
- * Create a snapshot of all dependencies from manifest information
1861
+ * Create a snapshot of all dependencies from manifest information
1861
1862
* @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
1862
1863
* You can upload multiple lockfiles in the same request, but each filename must be unique.
1863
- *
1864
+ *
1864
1865
* The name of the file must be in the supported list.
1865
- *
1866
+ *
1866
1867
* For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
1867
- *
1868
+ *
1868
1869
* This endpoint consumes 100 units of your quota.
1869
1870
*/
1870
1871
createDependenciesSnapshot : {
0 commit comments