Merge pull request #100 from SocketDev/automated/open-api

 Sync with OpenAPI definition

Author: 101arrowz

openapi.json

@@ -4759,7 +4759,7 @@
             ]
           }
         ],
-        "description": "Upload a lockfile to get your project analyzed by Socket.\nYou can upload multiple lockfiles in the same request, but each filename must be unique.\n\nThe name of the file must be in the supported list.\n\nThe supported lockfiles (and filenames) are: `package.json` and `package-lock.json`.\n\nFor example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.\n\nThis endpoint consumes 100 units of your quota.",
+        "description": "Upload a lockfile to get your project analyzed by Socket.\nYou can upload multiple lockfiles in the same request, but each filename must be unique.\n\nThe name of the file must be in the supported list.\n\nFor example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.\n\nThis endpoint consumes 100 units of your quota.",
         "responses": {
           "200": {
             "content": {
@@ -4857,6 +4857,56 @@
         "x-readme": {}
       }
     },
+    "/report/supported": {
+      "get": {
+        "tags": [
+          "Project report"
+        ],
+        "summary": "Get supported files for report",
+        "operationId": "getReportSupportedFiles",
+        "security": [
+          {}
+        ],
+        "description": "Get a list of supported files for project report generation.\nFiles are categorized first by environment (e.g. NPM or PyPI), then by name.\n\nFiles whose names match the patterns returned by this endpoint can be uploaded for report generation.\nExamples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.\n\nThis endpoint consumes 0 units of your quota.",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "properties": {
+                        "pattern": {
+                          "type": "string",
+                          "default": ""
+                        }
+                      },
+                      "required": [
+                        "pattern"
+                      ]
+                    },
+                    "properties": {}
+                  },
+                  "properties": {}
+                }
+              }
+            },
+            "description": "Glob patterns used to match supported files"
+          },
+          "400": {
+            "$ref": "#/components/responses/SocketBadRequest"
+          },
+          "429": {
+            "$ref": "#/components/responses/SocketTooManyRequestsResponse"
+          }
+        },
+        "x-readme": {}
+      }
+    },
     "/openapi": {
       "get": {
         "tags": [

types/api.d.ts

@@ -46,8 +46,6 @@ export interface paths {
      *
      * The name of the file must be in the supported list.
      *
-     * The supported lockfiles (and filenames) are: `package.json` and `package-lock.json`.
-     *
      * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
      *
      * This endpoint consumes 100 units of your quota.
@@ -62,6 +60,18 @@ export interface paths {
      */
     get: operations["getReport"];
   };
+  "/report/supported": {
+    /**
+     * Get a list of supported files for project report generation.
+     * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
+     *
+     * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
+     * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
+     *
+     * This endpoint consumes 0 units of your quota.
+     */
+    get: operations["getReportSupportedFiles"];
+  };
   "/openapi": {
     /**
      * Retrieve the API specification in an Openapi JSON format.
@@ -1443,8 +1453,6 @@ export interface operations {
    *
    * The name of the file must be in the supported list.
    *
-   * The supported lockfiles (and filenames) are: `package.json` and `package-lock.json`.
-   *
    * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
    *
    * This endpoint consumes 100 units of your quota.
@@ -1500,6 +1508,34 @@ export interface operations {
       429: components["responses"]["SocketTooManyRequestsResponse"];
     };
   };
+  /**
+   * Get a list of supported files for project report generation.
+   * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
+   *
+   * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
+   * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
+   *
+   * This endpoint consumes 0 units of your quota.
+   */
+  getReportSupportedFiles: {
+    responses: {
+      /** Glob patterns used to match supported files */
+      200: {
+        content: {
+          "application/json": {
+            [key: string]: {
+              [key: string]: {
+                /** @default */
+                pattern: string;
+              };
+            };
+          };
+        };
+      };
+      400: components["responses"]["SocketBadRequest"];
+      429: components["responses"]["SocketTooManyRequestsResponse"];
+    };
+  };
   /**
    * Retrieve the API specification in an Openapi JSON format.
    *