Skip to content

Added accessibility, tunnel & dynamic url details in API #1417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Added accessibility, tunnel & dynamic url details in API #1417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 28 additions & 11 deletions docs/kaneai-ci-cd-automation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ Open the test run to view its URL. Copy the Test Run ID from the URL. This ID wi
A list of test instances with various configurations will be displayed for each test run.
:::


### Step 3: Configure the API Call
Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:

- **concurrency :** Defaults to 1 if not specified.
- **title :** Assign a unique job title; a random one will be generated if omitted.
- **region :** Choose a region such as eastus or centralindia.
- **tunnel :** Add the parameter and tunnel name if you want to run using LambdaTest Tunnel.
- **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)
- **replaced_url :** To be used to dynamically replace any pattern URL in test cases with the replacement URL for entire test run.

#### Example API Call:

```yaml
Expand All @@ -78,11 +89,26 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute
"test_run_id": "YOUR_TEST_RUN_ID", #enter test run id
"concurrency": 1, # Optional, Default 1
"title": "UNIQUE_BUILD_NAME", #Optional
"region": "YOUR_DESIRED_REGION" #eastus, centralindia
"region": "YOUR_DESIRED_REGION", #eastus, centralindia
"tunnel":"tunnel-name", #Optional to be used if running via tunnel
"accessibility": false, #Optional
"replaced_url": [
{
"pattern_url": "TEST_URL_1",
"replacement_url": "REPLACED_TEST_URL_1"
},
{
"pattern_url": "TEST_URL_2",
"replacement_url": "REPLACED_TEST_URL_2"
},
{
"pattern_url": "TEST_URL_3",
"replacement_url": "REPLACED_TEST_URL_3"
}
] #Optional to be used to dynamically replace any pattern URL in test cases with the replacement URL
}'
```


#### Sample API Response:

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:
Expand All @@ -97,15 +123,6 @@ The API response contains the job ID for both jobs created for desktop web tests
}
```

### Step 3: Configure the API Call
Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:

- **Concurrency :** Defaults to 1 if not specified.
- **Title :** Assign a unique job title; a random one will be generated if omitted.
- **Region :** Choose a region such as eastus or centralindia.

Confirm that the job title is unique to avoid conflicts. Select a region if you require a specific allocation for your devices.


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