Skip to content

Commit b9529a3

Browse files
authored
Merge pull request #1421 from surishubham/main
Stage PRs- 1417, 19
2 parents b0ba57d + 178ec24 commit b9529a3

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

docs/kaneai-ci-cd-automation.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,17 @@ Open the test run to view its URL. Copy the Test Run ID from the URL. This ID wi
6868
A list of test instances with various configurations will be displayed for each test run.
6969
:::
7070

71+
72+
### Step 3: Configure the API Call
73+
Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:
74+
75+
- **concurrency :** Defaults to 1 if not specified.
76+
- **title :** Assign a unique job title; a random one will be generated if omitted.
77+
- **region :** Choose a region such as eastus or centralindia.
78+
- **tunnel :** Add the parameter and tunnel name if you want to run using LambdaTest Tunnel.
79+
- **accessibility :** Set as true if you want to run accessibility test on all your tests in the test run. (Could potentially slow the execution down if set as true)
80+
- **replaced_url :** To be used to dynamically replace any pattern URL in test cases with the replacement URL for entire test run.
81+
7182
#### Example API Call:
7283

7384
```yaml
@@ -78,11 +89,26 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute
7889
"test_run_id": "YOUR_TEST_RUN_ID", #enter test run id
7990
"concurrency": 1, # Optional, Default 1
8091
"title": "UNIQUE_BUILD_NAME", #Optional
81-
"region": "YOUR_DESIRED_REGION" #eastus, centralindia
92+
"region": "YOUR_DESIRED_REGION", #eastus, centralindia
93+
"tunnel": "tunnel-name", #Optional to be used if running via tunnel
94+
"accessibility": false, #Optional
95+
"replaced_url": [
96+
{
97+
"pattern_url": "TEST_URL_1",
98+
"replacement_url": "REPLACED_TEST_URL_1"
99+
},
100+
{
101+
"pattern_url": "TEST_URL_2",
102+
"replacement_url": "REPLACED_TEST_URL_2"
103+
},
104+
{
105+
"pattern_url": "TEST_URL_3",
106+
"replacement_url": "REPLACED_TEST_URL_3"
107+
}
108+
] #Optional to be used to dynamically replace any pattern URL in test cases with the replacement URL
82109
}'
83110
```
84111

85-
86112
#### Sample API Response:
87113

88114
The API response contains the job ID for both jobs created for desktop web tests as well as mobile tests on real devices. Here is a sample response for a test run which contains both app and web test cases:
@@ -97,15 +123,6 @@ The API response contains the job ID for both jobs created for desktop web tests
97123
}
98124
```
99125

100-
### Step 3: Configure the API Call
101-
Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:
102-
103-
- **Concurrency :** Defaults to 1 if not specified.
104-
- **Title :** Assign a unique job title; a random one will be generated if omitted.
105-
- **Region :** Choose a region such as eastus or centralindia.
106-
107-
Confirm that the job title is unique to avoid conflicts. Select a region if you require a specific allocation for your devices.
108-
109126

110127
### Step 4: Authenticate and Trigger the Job
111128
- Provide your LambdaTest username and access key for Basic Authentication.

0 commit comments

Comments
 (0)