77export interface paths {
88 "/npm/{package}/{version}/issues" : {
99 /**
10- * Get issues by package
10+ * Get issues by package
1111 * @description Get all the issues related with a particular npm package version.
1212 * This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
13- *
13+ *
1414 * You can [see here](https://socket.dev/npm/issue) the full list of issues.
15- *
15+ *
1616 * This endpoint consumes 1 unit of your quota.
1717 */
1818 get : operations [ "getIssuesByNPMPackage" ] ;
1919 } ;
2020 "/npm/{package}/{version}/score" : {
2121 /**
22- * Get score by package
22+ * Get score by package
2323 * @description Get all the scores and metrics by category that are used to evaluate the package version.
24- *
24+ *
2525 * This endpoint consumes 1 unit of your quota.
2626 */
2727 get : operations [ "getScoreByNPMPackage" ] ;
2828 } ;
2929 "/report/delete/{id}" : {
3030 /**
31- * Delete a report
31+ * Delete a report
3232 * @description Delete a specific project report.
33- *
33+ *
3434 * This endpoint consumes 10 units of your quota.
3535 */
3636 delete : operations [ "deleteReport" ] ;
3737 } ;
3838 "/report/list" : {
3939 /**
40- * Get list of reports
40+ * Get list of reports
4141 * @description Get all your project reports.
42- *
42+ *
4343 * This endpoint consumes 10 units of your quota.
4444 */
4545 get : operations [ "getReportList" ] ;
4646 } ;
4747 "/report/upload" : {
4848 /**
49- * Create a report
49+ * Create a report
5050 * @description Upload a lockfile to get your project analyzed by Socket.
5151 * You can upload multiple lockfiles in the same request, but each filename must be unique.
52- *
52+ *
5353 * The name of the file must be in the supported list.
54- *
54+ *
5555 * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
56- *
56+ *
5757 * This endpoint consumes 100 units of your quota.
5858 */
5959 put : operations [ "createReport" ] ;
6060 } ;
6161 "/report/view/{id}" : {
6262 /**
63- * View a report
63+ * View a report
6464 * @description Get all the issues, packages, and scores related to an specific project report.
65- *
65+ *
6666 * This endpoint consumes 10 units of your quota.
6767 */
6868 get : operations [ "getReport" ] ;
6969 } ;
7070 "/report/supported" : {
7171 /**
72- * Get supported files for report
72+ * Get supported files for report
7373 * @description Get a list of supported files for project report generation.
7474 * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
75- *
75+ *
7676 * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
7777 * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
78- *
78+ *
7979 * This endpoint consumes 0 units of your quota.
8080 */
8181 get : operations [ "getReportSupportedFiles" ] ;
8282 } ;
8383 "/openapi" : {
8484 /**
85- * Returns the OpenAPI definition
85+ * Returns the OpenAPI definition
8686 * @description Retrieve the API specification in an Openapi JSON format.
87- *
87+ *
8888 * This endpoint consumes 0 units of your quota.
8989 */
9090 get : operations [ "getOpenAPI" ] ;
9191 } ;
9292 "/quota" : {
9393 /**
94- * Get quota
94+ * Get quota
9595 * @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
96- *
96+ *
9797 * This endpoint consumes 0 units of your quota.
9898 */
9999 get : operations [ "getQuota" ] ;
100100 } ;
101101 "/organizations" : {
102102 /**
103- * List organizations
103+ * List organizations
104104 * @description Get information on the current organizations associated with the API key.
105- *
105+ *
106106 * This endpoint consumes 0 units of your quota.
107107 */
108108 get : operations [ "getOrganizations" ] ;
109109 } ;
110110 "/settings" : {
111111 /**
112- * Calculate settings
112+ * Calculate settings
113113 * @description Get your current settings the requested organizations and default settings to allow deferrals.
114- *
114+ *
115115 * This endpoint consumes 0 units of your quota.
116116 */
117117 post : operations [ "postSettings" ] ;
118118 } ;
119119 "/repo/list" : {
120120 /**
121- * Get list of repos and their latest project report
121+ * Get list of repos and their latest project report
122122 * @description Get all repositories in an org including their latest project report.
123- *
123+ *
124124 * This endpoint consumes 0 units of your quota.
125125 */
126126 get : operations [ "getRepoList" ] ;
127127 } ;
128128 "/dependencies/search" : {
129129 /**
130- * Search dependencies
130+ * Search dependencies
131131 * @description Search for any dependency that is being used in your organization.
132- *
132+ *
133133 * This endpoint consumes 0 units of your quota.
134134 */
135135 post : operations [ "searchDependencies" ] ;
136136 } ;
137137 "/dependencies/upload" : {
138138 /**
139- * Create a snapshot of all dependencies from manifest information
139+ * Create a snapshot of all dependencies from manifest information
140140 * @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
141141 * You can upload multiple lockfiles in the same request, but each filename must be unique.
142- *
142+ *
143143 * The name of the file must be in the supported list.
144- *
144+ *
145145 * For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
146- *
146+ *
147147 * This endpoint consumes 100 units of your quota.
148148 */
149149 post : operations [ "createDependenciesSnapshot" ] ;
@@ -1232,6 +1232,7 @@ export interface components {
12321232 severity : components [ "schemas" ] [ "SocketIssueSeverity" ] ;
12331233 category : components [ "schemas" ] [ "SocketCategory" ] ;
12341234 locations : components [ "schemas" ] [ "SocketRefList" ] ;
1235+ label : string ;
12351236 } ;
12361237 SocketUsageRef : {
12371238 file : components [ "schemas" ] [ "SocketRefFile" ] ;
@@ -1248,12 +1249,12 @@ export interface components {
12481249 value : Record < string , never > ;
12491250 } ;
12501251 /**
1251- * @default low
1252+ * @default low
12521253 * @enum {string}
12531254 */
12541255 SocketIssueSeverity : "low" | "middle" | "high" | "critical" ;
12551256 /**
1256- * @default miscellaneous
1257+ * @default miscellaneous
12571258 * @enum {string}
12581259 */
12591260 SocketCategory : "supplyChainRisk" | "quality" | "maintenance" | "vulnerability" | "license" | "miscellaneous" ;
@@ -1430,12 +1431,12 @@ export type external = Record<string, never>;
14301431export interface operations {
14311432
14321433 /**
1433- * Get issues by package
1434+ * Get issues by package
14341435 * @description Get all the issues related with a particular npm package version.
14351436 * This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
1436- *
1437+ *
14371438 * You can [see here](https://socket.dev/npm/issue) the full list of issues.
1438- *
1439+ *
14391440 * This endpoint consumes 1 unit of your quota.
14401441 */
14411442 getIssuesByNPMPackage : {
@@ -1460,9 +1461,9 @@ export interface operations {
14601461 } ;
14611462 } ;
14621463 /**
1463- * Get score by package
1464+ * Get score by package
14641465 * @description Get all the scores and metrics by category that are used to evaluate the package version.
1465- *
1466+ *
14661467 * This endpoint consumes 1 unit of your quota.
14671468 */
14681469 getScoreByNPMPackage : {
@@ -1487,9 +1488,9 @@ export interface operations {
14871488 } ;
14881489 } ;
14891490 /**
1490- * Delete a report
1491+ * Delete a report
14911492 * @description Delete a specific project report.
1492- *
1493+ *
14931494 * This endpoint consumes 10 units of your quota.
14941495 */
14951496 deleteReport : {
@@ -1516,9 +1517,9 @@ export interface operations {
15161517 } ;
15171518 } ;
15181519 /**
1519- * Get list of reports
1520+ * Get list of reports
15201521 * @description Get all your project reports.
1521- *
1522+ *
15221523 * This endpoint consumes 10 units of your quota.
15231524 */
15241525 getReportList : {
@@ -1542,14 +1543,14 @@ export interface operations {
15421543 } ;
15431544 } ;
15441545 /**
1545- * Create a report
1546+ * Create a report
15461547 * @description Upload a lockfile to get your project analyzed by Socket.
15471548 * You can upload multiple lockfiles in the same request, but each filename must be unique.
1548- *
1549+ *
15491550 * The name of the file must be in the supported list.
1550- *
1551+ *
15511552 * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
1552- *
1553+ *
15531554 * This endpoint consumes 100 units of your quota.
15541555 */
15551556 createReport : {
@@ -1582,9 +1583,9 @@ export interface operations {
15821583 } ;
15831584 } ;
15841585 /**
1585- * View a report
1586+ * View a report
15861587 * @description Get all the issues, packages, and scores related to an specific project report.
1587- *
1588+ *
15881589 * This endpoint consumes 10 units of your quota.
15891590 */
15901591 getReport : {
@@ -1608,13 +1609,13 @@ export interface operations {
16081609 } ;
16091610 } ;
16101611 /**
1611- * Get supported files for report
1612+ * Get supported files for report
16121613 * @description Get a list of supported files for project report generation.
16131614 * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
1614- *
1615+ *
16151616 * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
16161617 * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
1617- *
1618+ *
16181619 * This endpoint consumes 0 units of your quota.
16191620 */
16201621 getReportSupportedFiles : {
@@ -1637,9 +1638,9 @@ export interface operations {
16371638 } ;
16381639 } ;
16391640 /**
1640- * Returns the OpenAPI definition
1641+ * Returns the OpenAPI definition
16411642 * @description Retrieve the API specification in an Openapi JSON format.
1642- *
1643+ *
16431644 * This endpoint consumes 0 units of your quota.
16441645 */
16451646 getOpenAPI : {
@@ -1654,9 +1655,9 @@ export interface operations {
16541655 } ;
16551656 } ;
16561657 /**
1657- * Get quota
1658+ * Get quota
16581659 * @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
1659- *
1660+ *
16601661 * This endpoint consumes 0 units of your quota.
16611662 */
16621663 getQuota : {
@@ -1675,9 +1676,9 @@ export interface operations {
16751676 } ;
16761677 } ;
16771678 /**
1678- * List organizations
1679+ * List organizations
16791680 * @description Get information on the current organizations associated with the API key.
1680- *
1681+ *
16811682 * This endpoint consumes 0 units of your quota.
16821683 */
16831684 getOrganizations : {
@@ -1706,9 +1707,9 @@ export interface operations {
17061707 } ;
17071708 } ;
17081709 /**
1709- * Calculate settings
1710+ * Calculate settings
17101711 * @description Get your current settings the requested organizations and default settings to allow deferrals.
1711- *
1712+ *
17121713 * This endpoint consumes 0 units of your quota.
17131714 */
17141715 postSettings : {
@@ -1757,9 +1758,9 @@ export interface operations {
17571758 } ;
17581759 } ;
17591760 /**
1760- * Get list of repos and their latest project report
1761+ * Get list of repos and their latest project report
17611762 * @description Get all repositories in an org including their latest project report.
1762- *
1763+ *
17631764 * This endpoint consumes 0 units of your quota.
17641765 */
17651766 getRepoList : {
@@ -1803,9 +1804,9 @@ export interface operations {
18031804 } ;
18041805 } ;
18051806 /**
1806- * Search dependencies
1807+ * Search dependencies
18071808 * @description Search for any dependency that is being used in your organization.
1808- *
1809+ *
18091810 * This endpoint consumes 0 units of your quota.
18101811 */
18111812 searchDependencies : {
@@ -1857,14 +1858,14 @@ export interface operations {
18571858 } ;
18581859 } ;
18591860 /**
1860- * Create a snapshot of all dependencies from manifest information
1861+ * Create a snapshot of all dependencies from manifest information
18611862 * @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
18621863 * You can upload multiple lockfiles in the same request, but each filename must be unique.
1863- *
1864+ *
18641865 * The name of the file must be in the supported list.
1865- *
1866+ *
18661867 * For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
1867- *
1868+ *
18681869 * This endpoint consumes 100 units of your quota.
18691870 */
18701871 createDependenciesSnapshot : {
0 commit comments