schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
saucectl.schema.json | url | URL for the registry entry | {"type": "string"} |
saucectl.schema.json | authToken | authToken for the registry entry | {"type": "string"} |
saucectl.schema.json | then | Subschema for sauce specific settings | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"sauce": {"type": "object", "properties": {"concurrency": {"type": "integer", "minimum": 1}, "metadata": {"type": "object", "properties": {"build": {"type": "string"}, "tags": {"type": "array"}}, "additionalProperties": false}, "region": {"enum": ["us-west-1", "eu-central-1"]}, "sauceignore": {"default": ".sauceignore"}, "tunnel": {"properties": {"name": {"type": "string"}, "owner": {"type": "string"}}, "required": ["name"], "additionalProperties": false}, "retries": {"type": "integer", "minimum": 0}, "visibility": {"default": "team", "type": "string", "oneOf": [{"const": "public"}, {"const": "public restricted"}, {"const": "share"}, {"const": "team"}, {"const": "private"}]}, "launchOrder": {"type": "string", "oneOf": [{"const": "fail rate"}]}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | sauce | All settings related to how tests are run and identified in the Sauce Labs platform. | {"type": "object", "properties": {"concurrency": {"type": "integer", "minimum": 1}, "metadata": {"type": "object", "properties": {"build": {"type": "string"}, "tags": {"type": "array"}}, "additionalProperties": false}, "region": {"enum": ["us-west-1", "eu-central-1"]}, "sauceignore": {"default": ".sauceignore"}, "tunnel": {"properties": {"name": {"type": "string"}, "owner": {"type": "string"}}, "required": ["name"], "additionalProperties": false}, "retries": {"type": "integer", "minimum": 0}, "visibility": {"default": "team", "type": "string", "oneOf": [{"const": "public"}, {"const": "public restricted"}, {"const": "share"}, {"const": "team"}, {"const": "private"}]}, "launchOrder": {"type": "string", "oneOf": [{"const": "fail rate"}]}}, "additionalProperties": false} |
saucectl.schema.json | concurrency | Sets the maximum number of suites to execute at the same time. Excess suites are queued and run in order as each suite completes. | {"type": "integer", "minimum": 1} |
saucectl.schema.json | metadata | The set of properties that allows you to provide additional information about your project that helps you distinguish it in the various environments in which it is used and reviewed. | {"type": "object", "properties": {"build": {"type": "string"}, "tags": {"type": "array"}}, "additionalProperties": false} |
saucectl.schema.json | build | Sauce Labs can aggregate all jobs under one view based on their association with a build. | {"type": "string"} |
saucectl.schema.json | tags | Tag your jobs so you can find them easier in Sauce Labs. | {"type": "array"} |
saucectl.schema.json | region | Which Sauce Labs data center to target. | {"enum": ["us-west-1", "eu-central-1"]} |
saucectl.schema.json | sauceignore | Path to the .sauceignore file. | {"default": ".sauceignore"} |
saucectl.schema.json | tunnel | SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property. | {"properties": {"name": {"type": "string"}, "owner": {"type": "string"}}, "required": ["name"], "additionalProperties": false} |
saucectl.schema.json | name | The tunnel name. | {"type": "string"} |
saucectl.schema.json | owner | The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests. | {"type": "string"} |
saucectl.schema.json | retries | The number of times to retry a failing suite. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | visibility | Set the visibility level of test results for suites run on Sauce Labs. | {"default": "team", "type": "string", "oneOf": [{"const": "public"}, {"const": "public restricted"}, {"const": "share"}, {"const": "team"}, {"const": "private"}]} |
saucectl.schema.json | launchOrder | Control starting order of suites. The default is the order in which suites are written in the config file. | {"type": "string", "oneOf": [{"const": "fail rate"}]} |
saucectl.schema.json | then | Subschema for reporters specific settings | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"reporters": {"type": "object", "properties": {"junit": {"type": "object", "properties": {"enabled": {"type": "boolean"}, "filename": {"type": "string", "default": "saucectl-report.xml"}}}, "json": {"type": "object", "properties": {"enabled": {"type": "boolean"}, "webhookURL": {"type": "string"}, "filename": {"type": "string", "default": "saucectl-test-result.xml"}}}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | junit | The JUnit reporter merges test results from all jobs in the JUnit format into a single report. | {"type": "object", "properties": {"enabled": {"type": "boolean"}, "filename": {"type": "string", "default": "saucectl-report.xml"}}} |
saucectl.schema.json | enabled | Toggles the reporter on/off. | {"type": "boolean"} |
saucectl.schema.json | filename | Filename for the generated JUnit report. | {"type": "string", "default": "saucectl-report.xml"} |
saucectl.schema.json | json | The JSON reporter merges test results from all jobs in the JSON format into a single report. | {"type": "object", "properties": {"enabled": {"type": "boolean"}, "webhookURL": {"type": "string"}, "filename": {"type": "string", "default": "saucectl-test-result.xml"}}} |
saucectl.schema.json | enabled | Toggles the reporter on/off. | {"type": "boolean"} |
saucectl.schema.json | webhookURL | Webhook URL to pass JSON report. | {"type": "string"} |
saucectl.schema.json | filename | Filename for the generated JSON report. | {"type": "string", "default": "saucectl-test-result.xml"} |
saucectl.schema.json | showConsoleLog | Shows suites console.log locally. By default console.log is only shown on failures. | {"type": "boolean"} |
saucectl.schema.json | defaults | Settings that are applied onto every suite by default, if no value is set on a suite explicitly. | {"type": "object", "properties": {"timeout": {"type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": ["1h", "10m", "90s"]}}, "additionalProperties": false} |
saucectl.schema.json | timeout | Instructs how long (in ms, s, m, or h) saucectl should wait for a suite to complete. | {"type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": ["1h", "10m", "90s"]} |
saucectl.schema.json | rootDir | The directory of files that need to be bundled and uploaded for the tests to run. | {"type": "string"} |
saucectl.schema.json | cypress | Contains details specific to the Cypress project. | {"type": "object", "properties": {"configFile": {"type": "string", "examples": ["cypress.config.js"]}, "key": {"type": "string"}, "record": {"type": "boolean"}, "version": {"enum": ["package.json", "12.17.2", "12.14.0", "12.11.0", "12.6.0", "12.3.0", "11.2.0", "10.10.0", "10.7.0", "10.3.1"]}, "reporters": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"name": {"type": "string", "examples": ["dot", "nyan"]}, "options": {}}, "additionalProperties": false}}}, "required": ["configFile", "version"], "additionalProperties": false} |
saucectl.schema.json | configFile | The designated cypress configuration file. | {"type": "string", "examples": ["cypress.config.js"]} |
saucectl.schema.json | key | The secret key that grants permission to record your tests in the Cypress dashboard. | {"type": "string"} |
saucectl.schema.json | record | Whether to record your test results in the Cypress dashboard. | {"type": "boolean"} |
saucectl.schema.json | version | Which framework version to use. | {"enum": ["package.json", "12.17.2", "12.14.0", "12.11.0", "12.6.0", "12.3.0", "11.2.0", "10.10.0", "10.7.0", "10.3.1"]} |
saucectl.schema.json | reporters | Set of reporter to use. | {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"name": {"type": "string", "examples": ["dot", "nyan"]}, "options": {}}, "additionalProperties": false}} |
saucectl.schema.json | name | Name of the reporter. You may have to install the associated npm dependency through npm.packages field. | {"type": "string", "examples": ["dot", "nyan"]} |
saucectl.schema.json | options | Options to pass to the reporter. | {} |
saucectl.schema.json | env | Set one or more environment variables. Values can be environment variables themselves. Not supported when running espresso/xcuitest! | {"type": "object"} |
saucectl.schema.json | suites | The set of properties providing details about the test suites to run. | {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "browser": {"enum": ["chrome", "firefox", "microsoftedge", "webkit"]}, "browserVersion": {"type": "string"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {"type": "string"}, "config": {"type": "object", "properties": {"testingType": {"enum": ["e2e", "component"], "default": "e2e"}, "specPattern": {"type": "array"}, "excludeSpecPattern": {"type": "array"}, "env": {}}, "required": ["specPattern"]}, "shard": {"enum": ["", "concurrency", "spec"]}, "shardGrepEnabled": {"type": "boolean"}, "headless": {"type": "boolean"}, "timeout": {}, "preExec": {"type": "array"}, "timeZone": {"type": "string"}, "passThreshold": {"type": "integer", "minimum": 1}, "smartRetry": {"type": "object", "properties": {"failedOnly": {"type": "boolean", "default": false}}}}, "required": ["name", "browser", "config"], "additionalProperties": false}} |
saucectl.schema.json | name | The name of the test suite, which will be reflected in the test results in Sauce Labs. | {"type": "string"} |
saucectl.schema.json | browser | The name of the browser in which to run the tests. | {"enum": ["chrome", "firefox", "microsoftedge", "webkit"]} |
saucectl.schema.json | browserVersion | Which version of the browser to use. | {"type": "string"} |
saucectl.schema.json | platformName | A specific operating system on which to run the tests. Sauce Labs will try to choose a reasonable default if not explicitly specified. | {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]} |
saucectl.schema.json | screenResolution | Specifies a browser window screen resolution, which may be useful if you are attempting to simulate a browser on a particular device type. | {"type": "string"} |
saucectl.schema.json | config | Provides details related to the Cypress test configuration. | {"type": "object", "properties": {"testingType": {"enum": ["e2e", "component"], "default": "e2e"}, "specPattern": {"type": "array"}, "excludeSpecPattern": {"type": "array"}, "env": {}}, "required": ["specPattern"]} |
saucectl.schema.json | testingType | Specify the type of tests to execute; either e2e or component. Defaults to e2e | {"enum": ["e2e", "component"], "default": "e2e"} |
saucectl.schema.json | specPattern | One or more paths to the Cypress test files to run for this suite. | {"type": "array"} |
saucectl.schema.json | excludeSpecPattern | Exclude test files for this suite. | {"type": "array"} |
saucectl.schema.json | shard | When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel. | {"enum": ["", "concurrency", "spec"]} |
saucectl.schema.json | shardGrepEnabled | When sharding is configured and the suite is configured to filter using cypress-grep, let saucectl filter tests before executing. | {"type": "boolean"} |
saucectl.schema.json | headless | Controls whether or not tests are run in headless mode (default: false) | {"type": "boolean"} |
saucectl.schema.json | preExec | Specifies which commands to execute before starting the tests. | {"type": "array"} |
saucectl.schema.json | timeZone | Specifies the timeZone for the suite. | {"type": "string"} |
saucectl.schema.json | passThreshold | The minimum number of successful attempts for a suite to be considered as 'passed'. | {"type": "integer", "minimum": 1} |
saucectl.schema.json | smartRetry | Optimize suite retries by configuring the strategy. | {"type": "object", "properties": {"failedOnly": {"type": "boolean", "default": false}}} |
saucectl.schema.json | failedOnly | Optimize suite retries by retrying failed tests, classes or spec files only. | {"type": "boolean", "default": false} |
saucectl.schema.json | then | Configuration file for espresso using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "espresso"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "espresso": {"type": "object", "properties": {"app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array", "maxItems": 7}}, "required": ["app", "testApp"], "additionalProperties": false}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "testOptions": {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "func": {"type": "boolean"}, "unit": {"type": "boolean"}, "perf": {"type": "boolean"}, "package": {"type": "string"}, "notPackage": {"type": "string"}, "size": {"enum": ["small", "medium", "large"]}, "annotation": {"type": "string"}, "notAnnotation": {"type": "string"}, "filter": {"type": "array", "examples": [["com.android.foo.MyCustomFilter", "com.android.foo.MyOtherCustomFilter"]]}, "runnerBuilder": {"type": "array", "examples": [["com.android.foo.MyCustomBuilder", "com.android.foo.MyOtherCustomBuilder"]]}, "listener": {"type": "array", "examples": [["com.android.foo.MyRunListener", "com.android.foo.MyOtherRunListener"]]}, "newRunListenerMode": {"type": "boolean"}, "numShards": {"type": "integer", "minimum": 0}, "clearPackageData": {"type": "boolean"}, "useTestOrchestrator": {"type": "boolean"}}, "dependencies": {"clearPackageData": ["useTestOrchestrator"]}, "additionalProperties": true}, "emulators": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {"enum": ["landscape", "portrait"]}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}}, "devices": {"type": "array", "items": {"properties": {"id": {"type": "string", "examples": ["Google_Pixel_5_real", "Google_Pixel_5_real_us"]}, "name": {"type": "string", "examples": ["Google Pixel .*", "Samsung .*"]}, "platformVersion": {"type": "string"}, "options": {"type": "object", "properties": {"carrierConnectivity": {"type": "boolean"}, "deviceType": {"enum": ["ANY", "PHONE", "TABLET"]}, "private": {"type": "boolean"}}, "additionalProperties": false}}, "oneOf": [{"required": ["id"]}, {"required": ["name"]}], "additionalProperties": false}}, "timeout": {}, "appSettings": {"type": "object", "properties": {"audioCapture": {"type": "boolean"}, "instrumentation": {"type": "object", "properties": {"networkCapture": {"type": "boolean"}}}}}, "passThreshold": {}, "smartRetry": {}}, "anyOf": [{"required": ["emulators"]}, {"required": ["devices"]}], "required": ["name"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "espresso", "suites"], "additionalProperties": true} |
saucectl.schema.json | defaults | Settings that are applied onto every suite by default, if no value is set on a suite explicitly. | {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false} |
saucectl.schema.json | espresso | Contains details specific to the Espresso project. | {"type": "object", "properties": {"app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array", "maxItems": 7}}, "required": ["app", "testApp"], "additionalProperties": false} |
saucectl.schema.json | app | Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. | {"type": "string"} |
saucectl.schema.json | appDescription | Description for the app | {"type": "string"} |
saucectl.schema.json | testApp | Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. | {"type": "string"} |
saucectl.schema.json | testAppDescription | Description for the testApp | {"type": "string"} |
saucectl.schema.json | otherApps | A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. | {"type": "array", "maxItems": 7} |
saucectl.schema.json | suites | The set of properties providing details about the test suites to run. | {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "testOptions": {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "func": {"type": "boolean"}, "unit": {"type": "boolean"}, "perf": {"type": "boolean"}, "package": {"type": "string"}, "notPackage": {"type": "string"}, "size": {"enum": ["small", "medium", "large"]}, "annotation": {"type": "string"}, "notAnnotation": {"type": "string"}, "filter": {"type": "array", "examples": [["com.android.foo.MyCustomFilter", "com.android.foo.MyOtherCustomFilter"]]}, "runnerBuilder": {"type": "array", "examples": [["com.android.foo.MyCustomBuilder", "com.android.foo.MyOtherCustomBuilder"]]}, "listener": {"type": "array", "examples": [["com.android.foo.MyRunListener", "com.android.foo.MyOtherRunListener"]]}, "newRunListenerMode": {"type": "boolean"}, "numShards": {"type": "integer", "minimum": 0}, "clearPackageData": {"type": "boolean"}, "useTestOrchestrator": {"type": "boolean"}}, "dependencies": {"clearPackageData": ["useTestOrchestrator"]}, "additionalProperties": true}, "emulators": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {"enum": ["landscape", "portrait"]}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}}, "devices": {"type": "array", "items": {"properties": {"id": {"type": "string", "examples": ["Google_Pixel_5_real", "Google_Pixel_5_real_us"]}, "name": {"type": "string", "examples": ["Google Pixel .*", "Samsung .*"]}, "platformVersion": {"type": "string"}, "options": {"type": "object", "properties": {"carrierConnectivity": {"type": "boolean"}, "deviceType": {"enum": ["ANY", "PHONE", "TABLET"]}, "private": {"type": "boolean"}}, "additionalProperties": false}}, "oneOf": [{"required": ["id"]}, {"required": ["name"]}], "additionalProperties": false}}, "timeout": {}, "appSettings": {"type": "object", "properties": {"audioCapture": {"type": "boolean"}, "instrumentation": {"type": "object", "properties": {"networkCapture": {"type": "boolean"}}}}}, "passThreshold": {}, "smartRetry": {}}, "anyOf": [{"required": ["emulators"]}, {"required": ["devices"]}], "required": ["name"], "additionalProperties": false}} |
saucectl.schema.json | name | The name of the test suite, which will be reflected in the test results in Sauce Labs. | {"type": "string"} |
saucectl.schema.json | testApp | Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. | {"type": "string"} |
saucectl.schema.json | testAppDescription | Description for the testApp | {"type": "string"} |
saucectl.schema.json | testOptions | Allows you to control various details on how tests are executed. | {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "func": {"type": "boolean"}, "unit": {"type": "boolean"}, "perf": {"type": "boolean"}, "package": {"type": "string"}, "notPackage": {"type": "string"}, "size": {"enum": ["small", "medium", "large"]}, "annotation": {"type": "string"}, "notAnnotation": {"type": "string"}, "filter": {"type": "array", "examples": [["com.android.foo.MyCustomFilter", "com.android.foo.MyOtherCustomFilter"]]}, "runnerBuilder": {"type": "array", "examples": [["com.android.foo.MyCustomBuilder", "com.android.foo.MyOtherCustomBuilder"]]}, "listener": {"type": "array", "examples": [["com.android.foo.MyRunListener", "com.android.foo.MyOtherRunListener"]]}, "newRunListenerMode": {"type": "boolean"}, "numShards": {"type": "integer", "minimum": 0}, "clearPackageData": {"type": "boolean"}, "useTestOrchestrator": {"type": "boolean"}}, "dependencies": {"clearPackageData": ["useTestOrchestrator"]}, "additionalProperties": true} |
saucectl.schema.json | class | Only run the specified classes. | {"type": "array"} |
saucectl.schema.json | notClass | Run all classes except those specified here. | {"type": "array"} |
saucectl.schema.json | func | Run all test classes that extend InstrumentationTestCase. | {"type": "boolean"} |
saucectl.schema.json | unit | Run all test classes that do not extend either InstrumentationTestCase or PerformanceTestCase. | {"type": "boolean"} |
saucectl.schema.json | perf | Run all test classes that extend PerformanceTestCase. | {"type": "boolean"} |
saucectl.schema.json | package | Only run tests in the specified package. | {"type": "string"} |
saucectl.schema.json | notPackage | Run all tests except those in this package. | {"type": "string"} |
saucectl.schema.json | size | Run only tests that are annotated with the matching size value. | {"enum": ["small", "medium", "large"]} |
saucectl.schema.json | annotation | Only run tests with this annotation. | {"type": "string"} |
saucectl.schema.json | notAnnotation | Run all tests except those with this annotation. | {"type": "string"} |
saucectl.schema.json | filter | Only run tests that pass all of the custom filters. | {"type": "array", "examples": [["com.android.foo.MyCustomFilter", "com.android.foo.MyOtherCustomFilter"]]} |
saucectl.schema.json | runnerBuilder | Use custom builders to run tests. | {"type": "array", "examples": [["com.android.foo.MyCustomBuilder", "com.android.foo.MyOtherCustomBuilder"]]} |
saucectl.schema.json | listener | Observe the test run with one or more RunListener. | {"type": "array", "examples": [["com.android.foo.MyRunListener", "com.android.foo.MyOtherRunListener"]]} |
saucectl.schema.json | newRunListenerMode | Use the new list of RunListeners during a test run. | {"type": "boolean"} |
saucectl.schema.json | numShards | When sharding is configured, saucectl automatically creates the sharded jobs for each of the devices defined for the suite based on the number of shards you specify. For example, for a suite testing a single emulator version that specifies 2 shards, saucectl clones the suite and runs one shard index on the first suite, and the other shard index on the identical clone suite. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | clearPackageData | Removes all shared states from the testing device's CPU and memory at the completion of each test. Real devices only. Has to be used in conjunction with the 'useTestOrchestrator' flag. | {"type": "boolean"} |
saucectl.schema.json | useTestOrchestrator | Run each of your tests in its own Instrumentation instance to remove most of the app's shared state from the device CPU and memory between tests. Real devices only. Use this setting in conjunction with clearPackageData: true to completely remove all shared state. | {"type": "boolean"} |
saucectl.schema.json | emulators | Defines details for running this suite on virtual devices using an emulator. | {"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {"enum": ["landscape", "portrait"]}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}} |
saucectl.schema.json | name | The name of the emulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual). | {"type": "string"} |
saucectl.schema.json | orientation | The screen orientation to use. | {"enum": ["landscape", "portrait"]} |
saucectl.schema.json | platformVersions | The set of one or more versions of the device platform on which to run the test suite. | {"type": "array", "minItems": 1} |
saucectl.schema.json | devices | Define details for running this suite on real devices. | {"type": "array", "items": {"properties": {"id": {"type": "string", "examples": ["Google_Pixel_5_real", "Google_Pixel_5_real_us"]}, "name": {"type": "string", "examples": ["Google Pixel .*", "Samsung .*"]}, "platformVersion": {"type": "string"}, "options": {"type": "object", "properties": {"carrierConnectivity": {"type": "boolean"}, "deviceType": {"enum": ["ANY", "PHONE", "TABLET"]}, "private": {"type": "boolean"}}, "additionalProperties": false}}, "oneOf": [{"required": ["id"]}, {"required": ["name"]}], "additionalProperties": false}} |
saucectl.schema.json | id | Request a specific device for this test suite by its ID. You can look up device IDs in the Sauce Labs app or using our Devices API (https://docs.saucelabs.com/dev/api/rdc#get-devices). | {"type": "string", "examples": ["Google_Pixel_5_real", "Google_Pixel_5_real_us"]} |
saucectl.schema.json | name | Match the device name in full or partially (regex), which may provide a larger pool of available devices of the type you want. | {"type": "string", "examples": ["Google Pixel .*", "Samsung .*"]} |
saucectl.schema.json | platformVersion | The version of the Android operating system. | {"type": "string"} |
saucectl.schema.json | options | Further specify desired device attributes within the pool of devices that match the name and version criteria. | {"type": "object", "properties": {"carrierConnectivity": {"type": "boolean"}, "deviceType": {"enum": ["ANY", "PHONE", "TABLET"]}, "private": {"type": "boolean"}}, "additionalProperties": false} |
saucectl.schema.json | carrierConnectivity | Limit the device selection to those that are connected to a cellular network. | {"type": "boolean"} |
saucectl.schema.json | deviceType | Limit the device selection to a specific type of device. | {"enum": ["ANY", "PHONE", "TABLET"]} |
saucectl.schema.json | private | Limit the device selection to only match from your organization's private pool. | {"type": "boolean"} |
saucectl.schema.json | appSettings | Overwrite real device settings. | {"type": "object", "properties": {"audioCapture": {"type": "boolean"}, "instrumentation": {"type": "object", "properties": {"networkCapture": {"type": "boolean"}}}}} |
saucectl.schema.json | audioCapture | Overwrite app settings for real device to capture audio. | {"type": "boolean"} |
saucectl.schema.json | instrumentation | Overwrite app settings for real device instrumentation. | {"type": "object", "properties": {"networkCapture": {"type": "boolean"}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.