@msalaam/xray-qe-toolkit 1.3.2 → 1.3.4

package/README.md

@@ -253,8 +253,10 @@ Scaffold a new project with starter templates.
 npx xqt init
 ```
 
-**Cknowledge/` folder with subdirectories (`api-specs/`, `requirements/`, `tickets/`)
+**Creates:**
+- `knowledge/` folder with subdirectories (`api-specs/`, `requirements/`, `tickets/`)
 - `knowledge/README.md` — guide for organizing documentation
+- `XQT-GUIDE.md` — getting started guide for this toolkit (never named `README.md` to avoid overwriting yours)
 - `tests.json` — starter test definitions (marked as scaffolds)
 - `xray-mapping.json` — empty mapping file
 - `.env.example` — environment variable template

package/commands/genPipeline.js

@@ -2,7 +2,7 @@
  * Command: xray-qe gen-pipeline [--output <path>]
  *
  * Copies the Azure Pipelines YAML template into the consuming project.
- * The template runs Newman and imports results — no QE logic in CI.
+ * The template runs Playwright and imports JSON results — no QE logic in CI.
  */
 
 import fs from "node:fs";
@@ -34,8 +34,11 @@ export default async function genPipeline(opts = {}) {
   console.log("   1. Set pipeline variables in Azure DevOps:");
   console.log("      XRAY_ID, XRAY_SECRET, JIRA_PROJECT_KEY, JIRA_URL,");
   console.log("      JIRA_API_TOKEN, JIRA_EMAIL, TEST_EXEC_KEY");
-  console.log("   2. Commit the generated file to your repo");
-  console.log("   3. Create a pipeline in Azure DevOps pointing to this YAML");
+  console.log("   2. Optionally set API_BASE_URL for Playwright tests");
+  console.log("   3. Commit the generated file to your repo");
+  console.log("   4. Create a pipeline in Azure DevOps pointing to this YAML");
+  console.log("   5. Playwright tests must have xray annotations to map results:");
+  console.log("      test.info().annotations.push({ type: 'xray', description: 'PROJ-123' })");
   console.log("");
   console.log("⚠️  Remember: edit-json and QE review gates are NOT part of CI.");
   console.log("   Run those steps locally before committing.\n");

package/commands/init.js

@@ -59,15 +59,15 @@ export default async function init(opts = {}) {
     skipped++;
   }
 
-  // Copy main README
+  // Copy XQT guide — always written as XQT-GUIDE.md so the user's own README is never touched
   const readmeSrc = path.join(TEMPLATES, "README.template.md");
-  const readmeDest = path.join(cwd, "README.md");
-  if (!fs.existsSync(readmeDest)) {
-    fs.copyFileSync(readmeSrc, readmeDest);
-    logger.success("README.md created (Getting started guide)");
+  const guideDest = path.join(cwd, "XQT-GUIDE.md");
+  if (!fs.existsSync(guideDest)) {
+    fs.copyFileSync(readmeSrc, guideDest);
+    logger.success("XQT-GUIDE.md created (Getting started guide)");
     created++;
   } else {
-    logger.warn("README.md already exists — skipping");
+    logger.warn("XQT-GUIDE.md already exists — skipping");
     skipped++;
   }
 
@@ -114,7 +114,7 @@ export default async function init(opts = {}) {
     const xrayrc = {
       testsPath: "tests.json",
       mappingPath: "xray-mapping.json",
-      collectionPath: "collection.postman.json",
+      playwrightResultsPath: "playwright-results.json",
       knowledgePath: "knowledge",
       playwrightDir: "playwright-tests",
     };
@@ -132,10 +132,11 @@ export default async function init(opts = {}) {
   console.log("📖 Next steps:");
   console.log("   1. Copy .env.example → .env and fill in your credentials");
   console.log("   2. Add API specs and docs to knowledge/ folder (see knowledge/README.md)");
-  console.log("   3. Generate test cases: npx xray-qe gen-tests --ai (or edit tests.json manually)");
-  console.log("   4. Review tests: npx xray-qe edit-json");
-  console.log("   5. Push tests to Xray: npx xray-qe push-tests");
-  console.log("   6. Generate Postman collection: npx xray-qe gen-postman --ai");
-  console.log("   7. Generate CI pipeline: npx xray-qe gen-pipeline");
+  console.log("   3. See XQT-GUIDE.md for the full workflow and command reference");
+  console.log("   4. Generate test cases: npx xray-qe gen-tests --ai (or edit tests.json manually)");
+  console.log("   5. Review tests: npx xray-qe edit-json");
+  console.log("   6. Push tests to Xray: npx xray-qe push-tests");
+  console.log("   7. Generate CI pipeline: npx xqt gen-pipeline");
+  console.log("   8. Run Playwright tests and import results: npx xqt import-results --file playwright-results.json");
   console.log("");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msalaam/xray-qe-toolkit",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "Full QE workflow toolkit for Xray Cloud integration — test management, Postman generation, CI pipeline scaffolding, and browser-based review gates for API regression projects.",
   "type": "module",
   "bin": {

package/templates/README.template.md

@@ -1,6 +1,9 @@
-# Xray QE Toolkit Project
+# XQT-GUIDE — Xray QE Toolkit
 
 > Quality Engineering workflow automation for Xray Cloud integration
+>
+> This file was created by `npx xqt init`. It is intentionally named `XQT-GUIDE.md`
+> so it never overwrites your project's own `README.md`.
 
 ## Quick Start
 
@@ -60,13 +63,7 @@ npx xqt edit-json
 npx xqt push-tests
 ```
 
-### 5. Generate Postman Collection
-
-```bash
-npx xqt gen-postman
-```
-
-### 6. Set Up CI Pipeline
+### 5. Set Up CI Pipeline
 
 ```bash
 # Generate Azure Pipelines template
@@ -81,10 +78,9 @@ npx xqt gen-pipeline
 | `npx xqt gen-tests` | Generate test cases from knowledge/ |
 | `npx xqt edit-json` | Review/edit tests in browser |
 | `npx xqt push-tests` | Push tests to Xray Cloud |
-| `npx xqt gen-postman` | Generate Postman collection |
 | `npx xqt gen-pipeline` | Generate CI pipeline template |
 | `npx xqt create-execution` | Create Test Execution issue |
-| `npx xqt import-results` | Import test results (CI) |
+| `npx xqt import-results` | Import Playwright JSON results (CI) |
 
 Run any command with `--help` for details:
 ```bash
@@ -98,8 +94,9 @@ npx xqt gen-tests --help
 2. Generate tests (AI or manual)
 3. Review in edit-json
 4. Push to Xray
-5. Generate Postman collection
-6. Run in CI (newman + import-results)
+5. Generate CI pipeline: npx xqt gen-pipeline
+6. Run Playwright tests in CI
+7. Import results: npx xqt import-results --file playwright-results.json
 ```
 
 ## Files
@@ -108,7 +105,7 @@ npx xqt gen-tests --help
 |------|---------|
 | `tests.json` | Test definitions (source of truth) |
 | `xray-mapping.json` | Maps test IDs to JIRA keys |
-| `collection.postman.json` | Generated Postman collection |
+| `playwright-results.json` | Playwright JSON report (CI output) |
 | `.env` | Credentials (DO NOT COMMIT) |
 | `.xrayrc` | Project config |
 | `knowledge/` | API specs and requirements |

package/templates/azure-pipelines.yml

@@ -3,8 +3,8 @@
 # Generated by @msalaam/xray-qe-toolkit
 # ──────────────────────────────────────────────────────────────
 #
-# This pipeline runs Newman against the generated Postman collection
-# and imports results into Xray Cloud.
+# This pipeline runs Playwright tests and imports the JSON results
+# into Xray Cloud via xqt import-results.
 #
 # IMPORTANT: edit-json and QE review gates are NOT part of CI.
 # Those steps must be run locally before committing.
@@ -12,6 +12,9 @@
 # Required pipeline variables (set in Azure DevOps UI → Variables):
 #   XRAY_ID, XRAY_SECRET, JIRA_PROJECT_KEY, JIRA_URL,
 #   JIRA_API_TOKEN, JIRA_EMAIL, TEST_EXEC_KEY
+#
+# Optional pipeline variables:
+#   API_BASE_URL  — base URL passed to Playwright tests
 # ──────────────────────────────────────────────────────────────
 
 trigger:
@@ -24,7 +27,7 @@ pool:
   vmImage: "ubuntu-latest"
 
 variables:
-  NODE_VERSION: "18.x"
+  NODE_VERSION: "20.x"
 
 steps:
   - task: NodeTool@0
@@ -37,17 +40,24 @@ steps:
     displayName: "Install dependencies"
 
   - script: |
-      npx newman run collection.postman.json \
-        --reporters cli,junit \
-        --reporter-junit-export results.xml \
-        --suppress-exit-code
-    displayName: "Run Newman tests"
+      npx playwright install --with-deps chromium
+    displayName: "Install Playwright browsers"
+
+  - script: |
+      npx playwright test \
+        --reporter=list,json \
+        --output=playwright-results
+    displayName: "Run Playwright tests"
+    continueOnError: true
+    env:
+      PLAYWRIGHT_JSON_OUTPUT_NAME: playwright-results.json
+      API_BASE_URL: $(API_BASE_URL)
 
   - script: |
       npx xqt import-results \
-        --file results.xml \
+        --file playwright-results.json \
         --testExecKey $(TEST_EXEC_KEY)
-    displayName: "Import results to Xray"
+    displayName: "Import Playwright results to Xray"
     env:
       XRAY_ID: $(XRAY_ID)
       XRAY_SECRET: $(XRAY_SECRET)
@@ -57,9 +67,18 @@ steps:
       JIRA_EMAIL: $(JIRA_EMAIL)
 
   - task: PublishTestResults@2
-    displayName: "Publish JUnit results"
+    displayName: "Publish Playwright JUnit results"
+    condition: always()
     inputs:
       testResultsFormat: "JUnit"
-      testResultsFiles: "results.xml"
+      testResultsFiles: "playwright-results/results.xml"
       mergeTestResults: true
       failTaskOnFailedTests: true
+
+  - task: PublishPipelineArtifact@1
+    displayName: "Upload Playwright HTML report"
+    condition: always()
+    inputs:
+      targetPath: "playwright-report"
+      artifact: "playwright-report"
+      publishLocation: "pipeline"

package/templates/tests.json

@@ -1,603 +1,75 @@
-{
-  "testExecution": {
-    "summary": "AML CVS Regression Test Suite - Sprint Automated",
-    "description": "Automated regression test execution for AML Customer Verification Service API covering entity verification and certification endpoints"
-  },
-  "tests": [
-    {
-      "test_id": "APIEE-5952",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "negative"
-      ],
-      "xray": {
-        "summary": "Verify Failure with Completely Mismatched Name",
-        "description": "Test that entity verification fails when the registration name provided is completely mismatched from the data source. Complete failures should NOT return directors/propertyComparisons arrays, only overallResult=fail.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Validation",
-          "Negative"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with completely mismatched registration name",
-            "data": "Request: RegistrationNumber=1999/004643/06, RegistrationName='COMPLETELY WRONG COMPANY NAME THAT DOES NOT EXIST', Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate failure response contains message property",
-            "data": "Check response format: { message: 'An error occurred...' }",
-            "expected_result": "Response has 'message' property with descriptive error string (length > 0). Failures do NOT return overallResult, directors, or propertyComparisons"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5954",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "negative"
-      ],
-      "xray": {
-        "summary": "Verify Failure with Invalid Registration Number",
-        "description": "Test that entity verification fails when an invalid/non-existent registration number is provided. Complete failures return only overallResult=fail without directors/propertyComparisons.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Validation",
-          "Negative"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with invalid registration number",
-            "data": "Request: RegistrationNumber=9999/999999/99 (non-existent), RegistrationName='Old Mutual Life Assurance Company (South Africa)', Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate failure response contains message property",
-            "data": "Check response format: { message: 'An error occurred...' }",
-            "expected_result": "Response has 'message' property with descriptive error string (length > 0). Failures do NOT return overallResult, directors, or propertyComparisons"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5955",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "directors",
-        "negative"
-      ],
-      "xray": {
-        "summary": "Verify Failure with Director Mismatch",
-        "description": "Test that entity verification fails when provided directors do not match the entity's registered directors. Complete failures return only overallResult=fail without directors/propertyComparisons.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Directors",
-          "Validation"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with mismatched directors",
-            "data": "Request: RegistrationNumber=1999/004643/06, RegistrationName='Old Mutual Life Assurance Company (South Africa)', Directors with fake IDs that don't match. Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate failure response contains message property",
-            "data": "Check response format: { message: 'An error occurred...' }",
-            "expected_result": "Response has 'message' property with descriptive error string (length > 0). Failures do NOT return overallResult, directors, or propertyComparisons"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5960",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "positive",
-        "directors"
-      ],
-      "xray": {
-        "summary": "Verify Full Match Validation",
-        "description": "Test entity verification with 20 directors for Nedbank (1951/000009/06) where all directors match successfully. STRICT validation: must return exactly 'pass' (not 'pass with warning' or 'partial') with numberOfDirectorsMissing=0.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Validation",
-          "MultiDirector",
-          "FullMatch",
-          "Positive"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with Nedbank entity and 20 matching directors",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', 20 directors with all names matching data source. Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status OR 201 with async id"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "STRICT validation: overallResult must be exactly 'pass'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='pass' ONLY (NOT 'pass with warning', 'partial', or 'fail')"
-          },
-          {
-            "action": "Validate numberOfDirectorsMissing is 0",
-            "data": "Check numberOfDirectorsMissing field",
-            "expected_result": "numberOfDirectorsMissing=0 (all 20 directors matched)"
-          },
-          {
-            "action": "Validate directors array exists and is populated",
-            "data": "Check directors array is present with director objects",
-            "expected_result": "Directors array contains all matched directors with identityNumber, livingStatus, propertyComparisons fields"
-          },
-          {
-            "action": "Handle async response if returned",
-            "data": "If async response (201 with id): wait 2s, GET /aml/verify/entity/{messageId}, validate same strict rules",
-            "expected_result": "Async response also has overallResult='pass' and numberOfDirectorsMissing=0"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5961",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "directors",
-        "partial"
-      ],
-      "xray": {
-        "summary": "Verify Partial Match with One Missing Director",
-        "description": "Test entity verification with 19 directors (same payload as APIEE-5960 minus 1 director). STRICT validation: must return 'pass with warning' or 'partial' (NOT 'pass' or 'fail') with numberOfDirectorsMissing > 0.",
-        "priority": "Medium",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Directors",
-          "PartialMatch"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with 19 directors (one less than full match)",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', 19 directors (removed LINDA MAKALIMA from full 20 list). Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "STRICT validation: overallResult must be 'pass with warning' or 'partial'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='pass with warning' OR 'partial' ONLY (NOT 'pass' or 'fail')"
-          },
-          {
-            "action": "Validate numberOfDirectorsMissing is greater than 0",
-            "data": "Check numberOfDirectorsMissing field",
-            "expected_result": "numberOfDirectorsMissing > 0 (at least 1 director missing: LINDA MAKALIMA)"
-          },
-          {
-            "action": "Validate directors array exists and is populated",
-            "data": "Check directors array contains matched directors",
-            "expected_result": "Directors array is present with at least one director object"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5962",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "negative"
-      ],
-      "xray": {
-        "summary": "Verify Failure on Entity Name Mismatch",
-        "description": "Test that entity verification returns validation failure when the entity registration name doesn't match. Returns structured response with overallResult=Fail and propertyComparisons showing RegistrationName failed.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Validation",
-          "Negative"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with mismatched entity name",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Wrong Bank Name Limited', 1 director. Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "STRICT validation: overallResult must be 'fail'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='fail' for name mismatch validation failure"
-          },
-          {
-            "action": "Validate propertyComparisons shows RegistrationName failed",
-            "data": "Check propertyComparisons array for RegistrationName entry with result='Fail'",
-            "expected_result": "RegistrationName property comparison has result='Fail' with sourceValue=null"
-          },
-          {
-            "action": "Validate directors array exists",
-            "data": "Check directors field is present (may contain matched directors)",
-            "expected_result": "Directors array is present and may have directors from request"
-          },
-          {
-            "action": "Validate numberOfDirectorsMissing > 0",
-            "data": "Check numberOfDirectorsMissing field",
-            "expected_result": "numberOfDirectorsMissing > 0 indicating missing directors from data source"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5965",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "directors",
-        "negative"
-      ],
-      "xray": {
-        "summary": "Verify Fail When No Valid Directors Match",
-        "description": "Test that entity verification returns 'Fail' when request has correct registration details but all provided directors are fake/invalid and don't match any directors in the data source. API should return numberOfDirectorsMissing=20 (all real Nedbank directors missing).",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Directors",
-          "Negative",
-          "Validation"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with fake/invalid Directors",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', Directors=[2 fake directors with invalid IDs 9999999999999 and 8888888888888]. Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate overallResult is 'Fail'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='Fail' (NOT 'pass', 'pass with warning', or 'partial'). None of the provided directors match data source."
-          },
-          {
-            "action": "Validate directors array exists",
-            "data": "Check directors field is an array",
-            "expected_result": "directors array present (may contain the fake directors we sent)"
-          },
-          {
-            "action": "Validate numberOfDirectorsMissing is 20",
-            "data": "Check numberOfDirectorsMissing field",
-            "expected_result": "numberOfDirectorsMissing=20 (all 20 real Nedbank directors are missing since none of our fake directors matched)"
-          },
-          {
-            "action": "Validate propertyComparisons exists",
-            "data": "Check propertyComparisons array",
-            "expected_result": "propertyComparisons array present (registration should pass but directors fail)"
-          },
-          {
-            "action": "Validate response includes registration fields",
-            "data": "Check registrationNumber and registrationName fields",
-            "expected_result": "Response has registrationNumber and registrationName fields populated"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-6267",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "directors",
-        "response"
-      ],
-      "xray": {
-        "summary": "Verify Entity Name Details For All Directors",
-        "description": "Test that entity verification response includes the registration name and that all 20 Nedbank directors have complete details including identity numbers and property comparisons.",
-        "priority": "Medium",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Directors",
-          "ResponseValidation"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with valid entity and all 20 directors",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', all 20 directors. Source=CUPID, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status OR 201 with async id"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "STRICT validation: overallResult must be 'pass'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='pass' for positive test validation"
-          },
-          {
-            "action": "Validate registrationName is present and non-empty",
-            "data": "Check registrationName field is string type with length > 0",
-            "expected_result": "registrationName field exists and contains entity name string"
-          },
-          {
-            "action": "Validate all directors have required fields",
-            "data": "Iterate through directors array checking each has identityNumber and propertyComparisons",
-            "expected_result": "Each director object has identityNumber field and propertyComparisons array"
-          },
-          {
-            "action": "Handle async response if returned",
-            "data": "If async response (201 with id): wait 2s, GET /aml/verify/entity/{messageId}, validate same requirements",
-            "expected_result": "Async response also contains registrationName and directors with complete details"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-6270",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "directors",
-        "livingStatus"
-      ],
-      "xray": {
-        "summary": "Verify Entity Response Contains LivingStatus",
-        "description": "Test that entity verification response includes living status information for each director using all 20 Nedbank directors. This validates that the API provides complete director information including their living status.",
-        "priority": "Medium",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Directors",
-          "LivingStatus"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with valid entity and all 20 directors",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', all 20 directors with identity numbers. Source=LABEEQ, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status OR 201 with async id"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "STRICT validation: overallResult must be 'pass'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='pass' for positive test validation"
-          },
-          {
-            "action": "Validate directors array exists and is populated",
-            "data": "Check directors array is present with at least one director",
-            "expected_result": "Directors array length is greater than 0"
-          },
-          {
-            "action": "Validate each director has livingStatus field",
-            "data": "Iterate through directors array checking livingStatus and propertyComparisons fields",
-            "expected_result": "Each director object has livingStatus field (can be 'Alive' or null) and propertyComparisons array"
-          },
-          {
-            "action": "Handle async response if returned",
-            "data": "If async response (201 with id): wait 2s, GET /aml/verify/entity/{messageId}, validate same living status requirements",
-            "expected_result": "Async response also contains directors with livingStatus fields"
-          },
-          {
-            "action": "Handle null values for non South African directors",
-            "data": "livingStatus for DIrectors who are not South African will have null values. This is not a fail.",
-            "expected_result": "overallResult = PASS, all directors present in response."
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5975",
-      "type": "api",
-      "tags": [
-        "regression",
-        "verify",
-        "entity",
-        "positive"
-      ],
-      "xray": {
-        "summary": "Verify Data Source Used for ID Verification",
-        "description": "Test that entity verification correctly uses the data source to verify entity information with all 20 Nedbank directors. The response should include property comparisons with Levenshtein distance values showing how closely registration details match.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "VerifyEntity",
-          "Validation",
-          "DataSource"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/verify/entity with valid entity details and all 20 directors",
-            "data": "Request: RegistrationNumber=1951/000009/06, RegistrationName='Nedbank', all 20 directors. Source=CUPID, User=OM66803. Header: X-IBM-Client-Id",
-            "expected_result": "API returns HTTP 200 status OR 201 with async id"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate property comparisons exist and have levenshteinValue",
-            "data": "Check propertyComparisons array for propertyName, levenshteinValue (number), result",
-            "expected_result": "Each property comparison has levenshteinValue field (number type), propertyName, and result"
-          },
-          {
-            "action": "STRICT validation: overallResult must be 'pass'",
-            "data": "Check overallResult field (case-insensitive)",
-            "expected_result": "overallResult='pass' for positive test validation"
-          },
-          {
-            "action": "Validate registrationNumber and registrationName present",
-            "data": "Check response contains registrationNumber and registrationName fields",
-            "expected_result": "Response includes registrationNumber and registrationName from data source"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-5959",
-      "type": "api",
-      "tags": [
-        "regression",
-        "certify",
-        "entity",
-        "post"
-      ],
-      "xray": {
-        "summary": "Verify Certificate Generation for Validated Entity - POST",
-        "description": "Test that certificate generation via POST works correctly for a validated entity. The API should return a response containing id and CombinedEncodedPDF that can be used to retrieve the certificate document.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "CertifyEntity",
-          "Certificate",
-          "POST"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/certify/entity with validated entity data",
-            "data": "Request: RegistrationNumber, RegistrationName, Directors with full address details. Source=LABEEQ. Header: X-Gravitee-Api-Key (configured in service)",
-            "expected_result": "API returns HTTP 200 status OR 201 with async processing id"
-          },
-          {
-            "action": "Attach full response as test evidence",
-            "data": "Attach status, headers, and response body",
-            "expected_result": "Response evidence captured for Xray reporting"
-          },
-          {
-            "action": "Validate POST response structure contains Results array",
-            "data": "Check response format: {bh_response_code, http_code, Results: [{CombinedEncodedPDF, EncodedPDF, ...}]}",
-            "expected_result": "Response has http_code field, status_message field, and Results array"
-          },
-          {
-            "action": "Validate CombinedEncodedPDF exists in Results[0]",
-            "data": "Extract Results[0].CombinedEncodedPDF or Results[0].EncodedPDF",
-            "expected_result": "Results[0].CombinedEncodedPDF is a non-empty string in GUID format (e.g., 764e49c7-c693-4d89-ad56-675bcf6bcd14) that can be used for document retrieval"
-          }
-        ]
-      }
-    },
-    {
-      "test_id": "APIEE-6277",
-      "type": "api",
-      "tags": [
-        "regression",
-        "certify",
-        "entity",
-        "get"
-      ],
-      "xray": {
-        "summary": "Verify Certificate Generation for Validated Entity - GET",
-        "description": "Test that certificate document can be retrieved via GET endpoint using CombinedEncodedPDF from POST response. The GET /aml/certify/document/{CombinedEncodedPDF} endpoint should return the certificate with id, contentType, and content fields.",
-        "priority": "High",
-        "labels": [
-          "API",
-          "CertifyEntity",
-          "Certificate",
-          "GET"
-        ],
-        "steps": [
-          {
-            "action": "Send POST request to /aml/certify/entity to generate certificate",
-            "data": "Request: RegistrationNumber=1999/004643/06, RegistrationName='Old Mutual Life Assurance Company (South Africa)', Directors with address. Source=LABEEQ. Header: X-Gravitee-Api-Key (configured in service)",
-            "expected_result": "API returns HTTP 200 status OR 201"
-          },
-          {
-            "action": "Attach POST response as test evidence",
-            "data": "Attach status, headers, and response body from POST request",
-            "expected_result": "POST response evidence captured"
-          },
-          {
-            "action": "Extract CombinedEncodedPDF from Results array",
-            "data": "Get Results[0].CombinedEncodedPDF or Results[0].EncodedPDF field from POST response body",
-            "expected_result": "CombinedEncodedPDF is a non-empty GUID string (e.g., 764e49c7-c693-4d89-ad56-675bcf6bcd14)"
-          },
-          {
-            "action": "Wait 2 seconds for certificate processing",
-            "data": "Allow backend time to process and store certificate",
-            "expected_result": "Processing delay completed"
-          },
-          {
-            "action": "Send GET request to /aml/certify/document/{CombinedEncodedPDF}",
-            "data": "Use CombinedEncodedPDF from POST response as URL parameter. Header: X-IBM-Client-Id (configured in service)",
-            "expected_result": "API returns HTTP 200 status"
-          },
-          {
-            "action": "Attach GET response as test evidence",
-            "data": "Attach status, headers, and response body from GET request",
-            "expected_result": "GET response evidence captured"
-          },
-          {
-            "action": "Validate document response structure",
-            "data": "Check response contains id, contentType, and content fields",
-            "expected_result": "Response has id (defined), contentType (defined, e.g. 'application/pdf'), and content (base64 encoded PDF string with length > 0)"
-          }
-        ]
-      }
-    }
-  ]
+{
+  "testExecution": {
+    "summary": "My Project - Regression Suite",
+    "description": "Automated regression tests for My Project API"
+  },
+  "tests": [
+    {
+      "test_id": "TC-API-001",
+      "type": "api",
+      "skip": false,
+      "tags": ["regression", "smoke"],
+      "xray": {
+        "summary": "Verify successful response for valid request",
+        "description": "Test that the API returns the expected data and status code for a valid, well-formed request.",
+        "priority": "High",
+        "labels": ["API", "Positive", "Regression"],
+        "steps": [
+          {
+            "action": "Send GET request to /api/resource with valid parameters",
+            "data": "Method: GET, Headers: Authorization: Bearer {token}, Params: id=1",
+            "expected_result": "API returns HTTP 200 with resource object"
+          },
+          {
+            "action": "Validate response body structure",
+            "data": "Response body JSON",
+            "expected_result": "Response contains expected fields: id, name, status"
+          }
+        ]
+      }
+    },
+    {
+      "test_id": "TC-API-002",
+      "type": "api",
+      "skip": false,
+      "tags": ["regression", "negative"],
+      "xray": {
+        "summary": "Verify error response for invalid request",
+        "description": "Test that the API returns a descriptive error when invalid or missing input is provided.",
+        "priority": "Medium",
+        "labels": ["API", "Negative", "Validation"],
+        "steps": [
+          {
+            "action": "Send POST request to /api/resource with missing required fields",
+            "data": "Method: POST, Headers: Authorization: Bearer {token}, Body: {}",
+            "expected_result": "API returns HTTP 400 Bad Request"
+          },
+          {
+            "action": "Validate error response body",
+            "data": "Response body JSON",
+            "expected_result": "Response contains 'error' field with a descriptive message string"
+          }
+        ]
+      }
+    },
+    {
+      "test_id": "TC-API-003",
+      "type": "api",
+      "skip": true,
+      "tags": ["edge", "performance"],
+      "xray": {
+        "summary": "Verify API handles large payload within acceptable time",
+        "description": "Test that the API processes a large request payload without timeout or degraded response.",
+        "priority": "Low",
+        "labels": ["API", "Performance", "Edge"],
+        "steps": [
+          {
+            "action": "Send POST request to /api/resource with large payload",
+            "data": "Method: POST, Headers: Authorization: Bearer {token}, Body: large JSON array with 1000 items",
+            "expected_result": "API returns HTTP 200 within 3000ms"
+          }
+        ]
+      }
+    }
+  ]
 }