Merge branch 'main' into ctr-improvement

Author: nehagup

src/components/KeployCloud.js

@@ -6,7 +6,7 @@ export const KeployCloud = () => {
       id="cloud"
       className="mb-12 mt-24 flex max-w-7xl items-center space-x-5 rounded-lg bg-[color:var(--ifm-card-background-color)] p-5"
     >
-      <div className="max-w-3xl mx-auto prose prose-orange">
+      <div className="prose prose-orange mx-auto max-w-3xl">
         <h1> Question? 🤔💭</h1>
         <p className="my-3 block">
           For any support please{" "}

versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md

@@ -37,14 +37,14 @@ This project has two parts - the frontend and backend, since Keploy is a backend
 
 ## Setup the frontend
 
+### Prerequisites For Frontend:
+
+1. Node version 16.x and above
+
 ```bash
 git clone https://github.com/keploy/samples-java.git
 cd samples-java/spring-petclinic/spring-petclinic-angular
-npm uninstall -g angular-cli @angular/cli
-npm cache clean
-npm install -g @angular/cli@latest
-npm install --save-dev @angular/cli@latest
-npm i
+npm i --legacy-peer-deps
 ```
 
 ## Start the frontend
@@ -64,13 +64,12 @@ You can start the backend using Keploy in 2 ways:
 - [Using Keploy's binary](#instructions-for-starting-using-binary)
 - [Using Keploy's docker image](#instructions-for-starting-using-docker)
 
-# Instructions For Starting Using Binary
+# Instructions For Starting Using API backend Binary
 
-Prerequisites For Binary:
+Prerequisites For API backend Binary:
 
-1. Node 20.11.0 LTS
-2. OpenJDK 17.0.9
-3. MVN version 3.6.3
+1. OpenJDK 17+
+2. MVN version 3.6+
 
 ## Setup the backend
 

versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md

@@ -0,0 +1,88 @@
+---
+id: api-testing-chrome-extension
+title: API Test Recorder (Chrome Extension)
+sidebar_label: API Test Recorder
+description: Learn how to install, record, export, and auto-generate Keploy tests straight from your browser.
+---
+
+Install the extension, hit **Record API Calls**, exercise your web app, then press **Generate Tests** to send the captured traffic to Keploy.
+
+## What the API Test Recorder does
+
+**Browser-side traffic capture** — Sniffs XHR / fetch calls as you click around.
+
+**Instant replay formats** — Export the captured calls as cURL, JSON, or native Keploy YAML.
+
+**URL filtering & debugging** — Limit capture to specific endpoints and auto-repair partial request/response pairs.
+
+**One-click test generation** — Push traffic to Keploy Console and instantly get ready-to-run API tests with assertions.
+
+## Installation
+
+1. [Open the Chrome Web Store listing for **Keploy API Test Recorder**](https://chromewebstore.google.com/detail/keploy-api-test-recorder/ohcclfkaidblnjnggclkiecgkpgldihe)
+
+2. Click **Add to Chrome → Add Extension**.  
+   Chrome will download the signed build and enable it automatically.
+
+3. Pin the **Keploy API Test Recorder** icon for quick access:  
+   **Extensions** **⋮ → Pin**.
+
+## Quick-start workflow
+
+1. **Log in** with the same email you use on app.keploy.io.
+2. Click **Record API Calls**.
+3. In another tab, **exercise your app** as a normal user (create an account, add to cart, etc.).
+4. Watch the live counters:
+   - **Captured calls** – total XHR/fetch requests intercepted.
+   - **Complete req/resp** – pairs where both request _and_ response were fully captured.
+5. If the count of req/res is lower than expected, hit **Debug** to repair missing pairs.  
+   Example :
+
+```
+DEBUG SUMMARY:
+
+Total calls: 33
+Complete (status+body): 2
+Incomplete: 31
+Has status but no body: 13
+Has body but no status: 0
+Flagged as complete: 30
+Records repaired: 15
+```
+
+6. Press **Generate Tests**.
+   - The extension POSTs the capture set to `https://app.keploy.io`.
+   - Your browser opens a new tab showing test-case generation progress.
+   - When done, you’ll see a **Test Suite** with runnable cases
+7. From **Export Format**, choose:
+   - **cURL Commands** – one-liner per call, shareable in Slack/Gist.
+   - **Keploy YAML** – ready for `keploy run`.
+   - **JSON** – raw payloads for custom tooling.
+8. Click **Export Data** to download **or** **Copy** to clipboard.
+
+## UI reference
+
+| Button / Field        | Purpose                                           | Notes                                      |
+| --------------------- | ------------------------------------------------- | ------------------------------------------ |
+| **Logout**            | Clear auth token & stop background listeners.     | Re-login any time.                         |
+| **Record API Calls**  | Starts/stops the capture session.                 | Active state is shown in red.              |
+| **Captured calls**    | Blue counter of total requests.                   | Includes incomplete pairs.                 |
+| **Complete req/resp** | Green counter of fully captured pairs.            | This is the number exported.               |
+| **Check Status**      | Quick health-check of the local capture DB.       |
+| **Debug**             | Attempts to stitch orphaned requests & responses. |
+| **Reset DB**          | DANGER: Wipes all local capture data.             | Irreversible; handy before a new test run. |
+| **URL Filter**        | Regex or plain URL substring.                     | Leave blank to capture everything.         |
+| **Copy**              | Copies the export to clipboard.                   | Good for quick pastes into terminal.       |
+| **Generate Tests**    | Sends data to Keploy Console & redirects.         | Requires active internet.                  |
+
+## Best practices
+
+- **Enter URL** – Set the URL Filter to the base domain you want Keploy to record. This keeps captures focused on the traffic that matters.
+- **Keep sessions short** – Generate tests for one functional flow at a time; iterate rather than record everything in one go.
+
+## Troubleshooting
+
+| Symptom                                                      | Possible cause                               | Fix                                                                |
+| ------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------------ |
+| `Captured calls` increments, but `Complete req/resp` stays 0 | Responses blocked by CORS or Service Worker. | Click **Debug**, or whitelist the domain in extension permissions. |
+| “Network error” when pressing **Generate Tests**             | Auth token expired.                          | Log out, log back in.                                              |

versioned_docs/version-3.0.0/running-keploy/api-testing-cicd.md

@@ -0,0 +1,98 @@
+---
+id: api-testing-cicd
+title: API Test Setup for GitHub CI/CD
+sidebar_label: CI/CD Integration
+description: Learn how to seamlessly integrate Keploy's AI-powered API tests with GitHub Actions for continuous testing.
+tags:
+  - API testing
+  - test automation
+  - AI testing
+  - ci testing
+  - plugin
+  - ci pipeline
+keywords:
+  - fix failing tests
+  - ci testing
+  - ci/cd
+  - github
+---
+
+Keploy makes it super simple to run API tests during your CI/CD pipeline on GitHub. Here’s a step-by-step guide to help you set it up in just a few minutes!
+
+## Step 1: Get the Test Command from Keploy Dashboard
+
+1. Go to [app.keploy.io](https://app.keploy.io)
+2. Click on **Test Suite** in the sidebar
+
+![Test Suite Page](https://keploy-devrel.s3.us-west-2.amazonaws.com/testsuite-apitesting.png)
+
+3. You'll see an option to “Run test suites natively”
+
+![Run Natively Button](https://keploy-devrel.s3.us-west-2.amazonaws.com/apitestsuites.png)
+
+4. **Copy the command**  
+   ![Copy Command](https://keploy-devrel.s3.us-west-2.amazonaws.com/apitesting-ci-cmd.png)
+
+## Step 2: Set Up GitHub Actions Workflow
+
+Add the following steps to your `.github/workflows/ci.yml` file:
+
+### Install Keploy CLI
+
+```yaml
+- name: Install Keploy CLI
+  run: |
+    curl --silent -L https://keploy.io/ent/install.sh | bash
+```
+
+### Run Keploy API Tests
+
+Paste the command copied from the dashboard here:
+
+```yaml
+- name: Run Keploy Test Suite
+  run: |
+    export KEPLOY_API_KEY=${{ secrets.KEPLOY_API_KEY }}
+    keploy test-suite --app=03d24177-315c-4ee1-a3ac-64ed0ab38567 --base-path http://localhost:8080/books --cloud
+```
+
+### ⚠️ **Note**
+
+Don’t forget to add your `KEPLOY_API_KEY` as a GitHub secret!
+**Go to your repo → Settings → Security → Actions → _New Repository Secret_**
+
+Replace `--app` and `--base-path` with your actual values from the Keploy Dashboard.
+
+## Output Example: Real-time Test Execution Logs
+
+Once integrated, here’s what a successful run may look like in your GitHub Actions console:
+
+```sh
+🐰 Keploy: Running test suite	{"name": "Create and update one book verify other is unaffected via list"}
+🐰 Keploy: Running test case	{"name": "Create Book A"}
+🐰 Keploy: step passed	{"step": "Create Book A"}
+...
+
++------------------------------------------+--------+-------+
+| Test Case                                | Status | Runs  |
++------------------------------------------+--------+-------+
+| Create book with only title              | PASSED |     1 |
+| Create book with invalid progress        | PASSED |     1 |
+| Delete book by very large ID             | PASSED |     1 |
+| Update book by invalid ID format         | PASSED |     1 |
+| ...                                      | ...    |  ...  |
++------------------------------------------+--------+-------+
+
+Test suite execution summary
+Total suites:     122
+Passed suites:    122
+Failed suites:      0
+```
+
+## That's it!
+
+With just a few lines of YAML, you’ve added **AI-powered API test automation** into your GitHub CI pipeline. Now every PR or deployment will be automatically tested with Keploy’s smart test engine.
+
+import GetSupport from '../concepts/support.md'
+
+<GetSupport/>

versioned_docs/version-3.0.0/running-keploy/cli-commands.md

@@ -25,7 +25,7 @@ Here are some examples of how to use some common flags:
 
 | Mode        | Flags Available                                                                                                                                                                                                                                                                                                                          |
 | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `record`    | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug`                                                                                                                                                                                    |
+| `record`    | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug`                                                                                                                                                                      |
 | `test`      | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--coverage`, `--goCoverage`, `--ignoreOrdering`, `--skip-preview` |
 | `gen`       | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion`                                                                                                                                             |
 | `normailze` | `-p, --path`, `--test-run`, `--tests`                                                                                                                                                                                                                                                                                                    |
@@ -72,6 +72,18 @@ keploy record [flags]
   keploy record -c "node src/app.js" -d 10
   ```
 
+- `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name.
+
+  ```bash
+  keploy record -c "node src/app.js" --metadata "name=mac,env=production,service=gin-mongo,version=2.0.0,team.members[0]=alice,team.members[1]=bob,team.members[2]=carol,labels[0]=canary,labels[1]=stable,config.timeout=30s,config.timeout=60s,complex=a\\,b\\,c\\,d,database.urls[0]=db1.internal,database.urls[1]=db2.internal,database.urls[2]=db3.internal,mode=fast,mode=slow"
+  ```
+
+  ```bash
+  keploy record -c "node src/app.js" --metadata "name=mac,env=production,service=gin-mongo,version=2.0.0,team.members[0]=alice,team.members[1]=bob,team.members[2]=carol,labels[0]=canary,labels[1]=stable,config.timeout=30s,config.timeout=60s,complex=a\\,b\\,c\\,d,database.urls[0]=db1.internal,database.urls[1]=db2.internal,database.urls[2]=db3.internal,mode=fast,mode=slow"
+  ```
+
+  > **Note:** If the same key is used multiple times, the last occurrence will be used.
+
 - `- n, --network-name string` - Name of the docker network in which the user application is running.
 
   ```bash

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

@@ -53,15 +53,36 @@ 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.
 
-## Edit or Delete a Test Suite
+## 📚 Assertion Types & Examples
 
-Manage entire suites easily from the **Test Suites** list:
+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.
 
-- **︙ Menu**: Hover over any suite row to reveal options:
-  - ✏️ **Rename** – Update the title and description.
-  - 📄 **Duplicate** – Clone the suite with all steps and tags.
-  - 🗑️ **Delete** – Permanently remove the suite (with confirmation).
+| **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`               |
 
-All changes are saved instantly and logged.
+> **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 and Manage Test Suites
+
+In the Test Suites list, hover over any row to reveal the ︙ (more-options) menu:
 
-> ⚠️ Deletion is irreversible. Use Git history or backups to restore.
+**︙ Menu**: Hover over any suite row to reveal options:
+
+- **Add Test Suite** – Create a new suite and give it a clear, descriptive title.
+- **Select Test Suite** – Choose an existing suite for running or further changes.
+- **Edit Test Suite** – Update the suite’s name, description, or included tests.
+- **Delete Test Suite** – Permanently remove a suite you no longer need.
+
+All changes are saved instantly and logged.
+⚠️ Deletion is irreversible. Use Git history or backups to restore.