@bugbug-io/api-schema 13.39.1 → 14.0.2

package/dist/generated/v2.d.ts

@@ -295,6 +295,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v2/project/import/check/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Check whether a project ZIP is importable (stateless)
+         * @description **Stateless, read-only** check: confirms the ZIP is a well-formed project export (has `project.yaml`, no folder/slug collisions). No DB writes, no draft or upload artifact created unlike `import/validate` - safe to call repeatedly. Does not check against this organization's existing data, so a `200` here doesn't guarantee `import/validate` + `import/run` will succeed. Use for pre-flight checks, including by LLM/agent callers, before committing to `import/validate`.
+         */
+        post: operations["v2_project_import_check_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v2/project/import/run/": {
         parameters: {
             query?: never;
@@ -355,6 +375,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v2/projects/{project_pk}/backups/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List project backups
+         * @description Returns the backup schedule and unexpired backup archives for the selected project.
+         */
+        get: operations["v2_projects_backups_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v2/projects/{project_pk}/backups/{id}/download/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download project backup
+         * @description Downloads an unexpired project backup as a ZIP archive.
+         */
+        get: operations["v2_projects_backups_download_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v2/projects/{project_pk}/settings/": {
         parameters: {
             query?: never;
@@ -1037,6 +1097,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v2/tests/import/check/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Check whether a test YAML or ZIP is importable (stateless)
+         * @description **Stateless, read-only** check: confirms the YAML/ZIP is a well-formed test export (right schema, no folder/slug collisions). No DB writes, unlike `import` which writes immediately whenever there's no slug conflict - safe to call repeatedly. Does not check against this project's existing tests/components, so a `200` here doesn't guarantee `import` will succeed. Use for pre-flight checks, including by LLM/agent callers, before committing to `import`.
+         */
+        post: operations["v2_tests_import_check_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v2/variables/": {
         parameters: {
             query?: never;
@@ -1134,6 +1214,10 @@ export interface paths {
         delete: operations["v2_visual_regression_reference_screenshots_destroy"];
         options?: never;
         head?: never;
+        /**
+         * Update visual regression reference screenshot
+         * @description Updates a visual regression reference screenshot.
+         */
         patch: operations["v2_visual_regression_reference_screenshots_partial_update"];
         trace?: never;
     };
@@ -3260,6 +3344,7 @@ export interface components {
         PatchedV2SuiteCreate: {
             autoAddNewTests?: boolean;
             autoRetry?: number;
+            beforeAfterAllEnabled?: boolean;
             /** Suite notes */
             notes?: string | null;
             name?: string | null;
@@ -3267,6 +3352,8 @@ export interface components {
             /** Format: uuid */
             runProfileId?: string;
             tests?: string[];
+            beforeAll?: string[];
+            afterAll?: string[];
         };
         PatchedV2TestCreate: {
             name?: string | null;
@@ -3282,31 +3369,51 @@ export interface components {
             /** Format: uuid */
             folderId?: string | null;
         };
-        PatchedV2VisualRegressionRefScreenshot: {
-            /** Format: uuid */
-            readonly id?: string;
-            /** Format: uuid */
-            readonly stepId?: string;
-            /** Format: uuid */
-            readonly projectArtifactId?: string | null;
-            readonly screenshotUrl?: string | null;
-            readonly browserName?: string | null;
-            readonly osName?: string | null;
-            readonly screenSizeType?: string | null;
+        PatchedV2VisualRegressionRefScreenshotUpdate: {
+            /** Format: uri */
+            screenshot?: string;
+        };
+        ProjectBackup: {
             /** Format: uuid */
-            readonly runProfileId?: string | null;
-            readonly runProfileName?: string;
+            readonly id: string;
+            /** Format: date-time */
+            readonly created: string;
+            /** Format: date-time */
+            expiresAt: string;
+            readonly testsCount: number;
+            readonly suitesCount: number;
+            readonly retentionDays: number;
             /**
-             * @description * `server` - cloud
-             *     * `local` - local
-             *     * `recording` - recording
-             * @enum {string|null}
+             * @description * `automatic` - Automatic
+             * @enum {string}
              */
-            readonly runMode?: "server" | "local" | "recording" | null;
-            /** Format: date-time */
-            readonly created?: string;
+            readonly triggeredBy: "automatic";
+        };
+        ProjectBackupList: {
+            isActive: boolean;
+            frequencyDays: number;
+            retentionDays: number | null;
             /** Format: date-time */
-            readonly modified?: string;
+            nextBackupAt: string | null;
+            backups: components["schemas"]["ProjectBackup"][];
+        };
+        ProjectImportCheckRequest: {
+            /**
+             * Format: uri
+             * @description Project ZIP file to check.
+             */
+            file: string;
+        };
+        ProjectImportCheckResult: {
+            /** @description Always `true` when the response is 200. */
+            valid: boolean;
+            summary: components["schemas"]["ProjectImportCheckSummary"];
+        };
+        ProjectImportCheckSummary: {
+            tests: number;
+            components: number;
+            suites: number;
+            profiles: number;
         };
         ProjectImportRunRequest: {
             /**
@@ -3583,6 +3690,22 @@ export interface components {
              */
             value: "topFrame" | "iframe";
         };
+        TestImportCheckRequest: {
+            /**
+             * Format: uri
+             * @description YAML or ZIP file to check.
+             */
+            file: string;
+        };
+        TestImportCheckResult: {
+            /** @description Always `true` when the response is 200. */
+            valid: boolean;
+            summary: components["schemas"]["TestImportCheckSummary"];
+        };
+        TestImportCheckSummary: {
+            tests: number;
+            components: number;
+        };
         TestImportConflict: {
             /**
              * @description * `conflict` - conflict
@@ -3956,6 +4079,12 @@ export interface components {
             componentId?: string;
             atIndex?: number | null;
         };
+        V2LatestRun: {
+            /** Format: uuid */
+            readonly id: string;
+            readonly status: string;
+            readonly webappUrl: string;
+        };
         V2Organization: {
             /** Format: uuid */
             readonly id: string;
@@ -4589,17 +4718,26 @@ export interface components {
             readonly tests: {
                 [key: string]: unknown;
             }[];
+            readonly beforeAll: {
+                [key: string]: unknown;
+            }[];
+            readonly afterAll: {
+                [key: string]: unknown;
+            }[];
             readonly autoAddNewTests: boolean;
             readonly autoRetry: number;
+            readonly beforeAfterAllEnabled: boolean;
             /** Suite notes */
             readonly notes: string | null;
             readonly runInParallel: boolean;
             /** Format: uuid */
             readonly runProfileId: string | null;
+            readonly latestRun: components["schemas"]["V2LatestRun"] | null;
         };
         V2SuiteCreate: {
             autoAddNewTests?: boolean;
             autoRetry?: number;
+            beforeAfterAllEnabled?: boolean;
             /** Suite notes */
             notes?: string | null;
             name?: string | null;
@@ -4607,6 +4745,8 @@ export interface components {
             /** Format: uuid */
             runProfileId: string;
             tests?: string[];
+            beforeAll?: string[];
+            afterAll?: string[];
         };
         V2SuiteDetails: {
             /** Format: uuid */
@@ -4616,16 +4756,25 @@ export interface components {
             readonly tests: {
                 [key: string]: unknown;
             }[];
+            readonly beforeAll: {
+                [key: string]: unknown;
+            }[];
+            readonly afterAll: {
+                [key: string]: unknown;
+            }[];
             readonly autoAddNewTests: boolean;
             readonly autoRetry: number;
+            readonly beforeAfterAllEnabled: boolean;
             /** Suite notes */
             readonly notes: string | null;
             readonly runInParallel: boolean;
             /** Format: uuid */
             readonly runProfileId: string | null;
+            readonly latestRun: components["schemas"]["V2LatestRun"] | null;
             readonly webappUrl: string;
         };
         V2SuiteRun: {
+            readonly beforeAfterAllEnabled: boolean;
             readonly duration: string | null;
             /** Format: date-time */
             readonly ended: string | null;
@@ -4709,6 +4858,7 @@ export interface components {
             name?: string;
             /** Format: uuid */
             folderId?: string | null;
+            readonly latestRun: components["schemas"]["V2LatestRun"] | null;
         };
         V2TestCreate: {
             name?: string | null;
@@ -4730,6 +4880,7 @@ export interface components {
             name?: string;
             /** Format: uuid */
             folderId?: string | null;
+            readonly latestRun: components["schemas"]["V2LatestRun"] | null;
             readonly groups: string;
             /** Test notes */
             readonly notes: string | null;
@@ -4781,6 +4932,13 @@ export interface components {
              * @enum {string}
              */
             readonly screenSizeType: "desktop" | "mobile" | "custom";
+            /**
+             * @description * `main` - Main
+             *     * `before_all` - Before all
+             *     * `after_all` - After all
+             * @enum {string}
+             */
+            readonly section: "main" | "before_all" | "after_all";
             readonly sequence: number | null;
             /** Format: date-time */
             readonly started: string | null;
@@ -5388,6 +5546,7 @@ export interface operations {
     v2_groups_list: {
         parameters: {
             query?: {
+                folder?: string;
                 folderId?: string;
                 noFolder?: boolean;
                 ordering?: "-created" | "-name" | "created" | "name";
@@ -5752,6 +5911,43 @@ export interface operations {
             };
         };
     };
+    v2_project_import_check_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "multipart/form-data": components["schemas"]["ProjectImportCheckRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectImportCheckResult"];
+                };
+            };
+            /** @description File missing, too large, or structurally invalid ZIP. See `message` for the reason. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     v2_project_import_run_create: {
         parameters: {
             query?: never;
@@ -5861,6 +6057,79 @@ export interface operations {
             };
         };
     };
+    v2_projects_backups_list: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                project_pk: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectBackupList"][];
+                };
+            };
+            /** @description Authentication credentials were not provided. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Project not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    v2_projects_backups_download_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A UUID string identifying this project backup. */
+                id: string;
+                project_pk: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ZIP archive download. Content-Type is `application/zip`. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": string;
+                };
+            };
+            /** @description Authentication credentials were not provided. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Project or backup not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     v2_projects_settings_list_2: {
         parameters: {
             query?: never;
@@ -6214,8 +6483,8 @@ export interface operations {
     v2_suiteruns_list: {
         parameters: {
             query?: {
-                /** @description Which field to use when ordering the results. */
-                ordering?: string;
+                /** @description Sort list by param */
+                ordering?: "-created" | "-started" | "created" | "started";
                 /** @description A page number within the paginated result set. */
                 page?: number;
                 /** @description Number of results to return per page. */
@@ -6525,6 +6794,8 @@ export interface operations {
     v2_suites_list: {
         parameters: {
             query?: {
+                /** @description Include the latest run summary for each suite. */
+                latestRun?: boolean;
                 ordering?: "-created" | "-name" | "created" | "name";
                 /** @description A page number within the paginated result set. */
                 page?: number;
@@ -6762,7 +7033,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description Sort list by param */
-                ordering?: "-started" | "started";
+                ordering?: "-created" | "-started" | "created" | "started";
                 /** @description A page number within the paginated result set. */
                 page?: number;
                 /** @description Number of results to return per page. */
@@ -7144,7 +7415,10 @@ export interface operations {
     v2_tests_list: {
         parameters: {
             query?: {
+                folder?: string;
                 folderId?: string;
+                /** @description Include the latest run summary for each test. */
+                latestRun?: boolean;
                 noFolder?: boolean;
                 ordering?: "-created" | "-name" | "created" | "name";
                 /** @description A page number within the paginated result set. */
@@ -7564,6 +7838,43 @@ export interface operations {
             };
         };
     };
+    v2_tests_import_check_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "multipart/form-data": components["schemas"]["TestImportCheckRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TestImportCheckResult"];
+                };
+            };
+            /** @description File missing, too large, or structurally invalid. See `message` for the reason. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     v2_variables_list: {
         parameters: {
             query?: never;
@@ -7912,8 +8223,8 @@ export interface operations {
         };
         requestBody?: {
             content: {
-                "application/x-www-form-urlencoded": components["schemas"]["PatchedV2VisualRegressionRefScreenshot"];
-                "application/json": components["schemas"]["PatchedV2VisualRegressionRefScreenshot"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedV2VisualRegressionRefScreenshotUpdate"];
+                "application/json": components["schemas"]["PatchedV2VisualRegressionRefScreenshotUpdate"];
             };
         };
         responses: {