Added run, edited existing with changes (#590)

Author: TvisharajiK

versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md

@@ -53,6 +53,26 @@ Keploy lets you refine both the **request definition** and the **assertions** fr
 
 Hit **Save Changes** – every edit is version‑controlled so you can roll back anytime.
 
+## 📚 Assertion Types & Examples
+
+Keploy supports nine assertion primitives out-of-the-box.  
+Mix-and-match them as needed—every example below can live inside the same `assertions:` array of a test step.
+
+| **Type**              | **What It Checks**                                     | **YAML Snippet**                                                                                           | **Passing Example**                                                          |
+| --------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| **Status Code**       | Response code equals an exact number.                  | `yaml<br>- type: status_code<br>  comparator: equal<br>  expected: 201<br>`                                | `POST /users` returns **201 Created**                                        |
+| **Status Code Class** | Response code falls within a class (2xx, 3xx …).       | `yaml<br>- type: status_code_class<br>  comparator: equal<br>  expected: 2xx<br>`                          | `PATCH /users/42` → **204 No Content**                                       |
+| **Status Code In**    | Response code is one of a whitelist of codes.          | `yaml<br>- type: status_code_in<br>  expected: [200, 201, 202]<br>`                                        | Upload API may respond with **202 Accepted** while processing async          |
+| **JSON Equal**        | **Entire** JSON body matches exactly (order-agnostic). | `yaml<br>- type: json_equal<br>  expected:<br>    id: 42<br>    status: "shipped"<br>`                     | Warehouse service returns `{ "status": "shipped", "id": 42 }`                |
+| **JSON Contains**     | Body **contains** a subset of fields/values.           | `yaml<br>- type: json_contains<br>  expected:<br>    status: "error"<br>    message: "invalid token"<br>`  | Auth service returns a long error payload that **includes** those two fields |
+| **Header Contains**   | Specific header **includes** a substring.              | `yaml<br>- type: header_contains<br>  field: content-type<br>  expected: json<br>`                         | `content-type: application/**json**; charset=utf-8`                          |
+| **Header Equal**      | Header equals an exact value (case-insensitive).       | `yaml<br>- type: header_equal<br>  field: cache-control<br>  expected: "no-store"<br>`                     | `cache-control: No-Store` (case doesn’t matter)                              |
+| **Header Exists**     | Header key is present (value ignored).                 | `yaml<br>- type: header_exists<br>  field: x-request-id<br>`                                               | Reverse-proxy injects `x-request-id: 4b087…`                                 |
+| **Header Matches**    | Header value matches a **regex** pattern.              | `yaml<br>- type: header_matches<br>  field: set-cookie<br>  pattern: "sessionId=.*; Path=/; HttpOnly"<br>` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax`               |
+
+> **Tip 🛠️**  
+> Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch.
+
 ## Edit or Delete a Test Suite
 
 Manage entire suites easily from the **Test Suites** list:

versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md

@@ -0,0 +1,50 @@
+---
+id: run-ai-generated-api-tests
+title: Run AI-Generated API Tests
+sidebar_label: Run Tests
+description: Discover how to execute Keploy’s AI-generated API test suites—locally, on-demand from the console, or automatically in CI/CD—and interpret the results to keep your API stable.
+---
+
+Once you’ve finished curating a suite , it’s time to hit **Run** and see how your API behaves against the latest contract.
+
+## Open the **Run Tests** Modal
+
+1. In the top-right of the Test-Suite workspace, click the green **Run Tests** button.
+
+2. The modal will open with **two tabs**:
+
+   | Tab                | What to Fill In                                                                                                                                                      |
+   | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   | **Endpoint**       | **API Endpoint URL** – the base URL Keploy will prepend to every request in the suite (e.g. `https://jsonplaceholder.typicode.com`).                                 |
+   | **Authentication** | (Optional) Drop in a **Bearer**, **Basic**, or **API-key** credential that applies to every step.<br />You can also add per-step auth later in the test-step editor. |
+
+3. Click **Run Tests** to start execution. A toast confirmation appears and the modal closes.
+
+## Watch the Run Spin Up
+
+A **Run Badge** next to each suite row flips from _queued_ → _running_ → _✔ passed_ or _✖ failed_ in real time.
+
+## View the Test-Run Report
+
+1. Click the **📄 View Test Run Report** link that appears in the toast, or switch to the **Run Reports** icon in the sidebar.
+2. The summary table shows:
+
+   | Column                      | Meaning                                                    |
+   | --------------------------- | ---------------------------------------------------------- |
+   | **Report ID**               | UUID of this run (use it in CI logs or API calls).         |
+   | **Created At**              | Timestamp the run was triggered.                           |
+   | **Creator**                 | Email or token that kicked off the run.                    |
+   | **Total / Passed / Failed** | Quick health check of your suite.                          |
+   | **Status**                  | `QUEUED`, `RUNNING`, or `COMPLETED` (green if 100 % pass). |
+
+3. Click any **Report ID** to drill into per-test details: request/response dumps, assertion diff views, execution time, and re-run buttons for flaky steps.
+
+## Re-running After Fixes
+
+Iterate quickly:
+
+1. Patch your API or tweak assertions from the "Test Suite".
+2. Re-click **Run Tests**—Keploy re-uses the same Endpoint/Auth settings you last entered.
+3. Compare the new report with the previous one right in the dashboard to verify the fix.
+
+You now have a pipeline—from triggering the run to an all-green build—that safeguards your API contract in every environment.

versioned_sidebars/version-3.0.0-sidebars.json

@@ -22,7 +22,9 @@
           "items": [
             "running-keploy/review-and-improve-ai-generated-tests",
                     "running-keploy/share-tests",
-            "running-keploy/self-healing-ai-api-tests"
+            "running-keploy/self-healing-ai-api-tests",
+            "running-keploy/run-ai-generated-api-tests"
+
           ]
         },
         {