schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
saucectl.schema.json | networkCapture | Overwrite app settings for real device to capture network. | {"type": "boolean"} |
saucectl.schema.json | then | Configuration file for playwright using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}, {}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "playwright"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "env": {}, "rootDir": {}, "playwright": {"type": "object", "properties": {"version": {"enum": ["package.json", "1.36.2", "1.35.1", "1.33.0", "1.31.1", "1.29.2", "1.28.1", "1.27.1", "1.25.1", "1.24.1", "1.22.2"]}, "configFile": {"type": "string"}}, "required": ["version"], "additionalProperties": false}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "playwrightVersion": {}, "testMatch": {"type": "array"}, "excludedTestFiles": {"type": "array"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "params": {"type": "object", "properties": {"browserName": {"enum": ["chromium", "firefox", "webkit", "chrome"]}, "headless": {"type": "boolean"}, "globalTimeout": {"type": "integer"}, "timeout": {"type": "integer"}, "grep": {"type": "string"}, "grepInvert": {"type": "string"}, "repeatEach": {"type": "integer", "minimum": 0}, "retries": {"type": "integer", "minimum": 0}, "maxFailures": {"type": "integer", "minimum": 0}, "project": {"type": "string"}, "updateSnapshots": {"type": "boolean"}, "workers": {"type": "integer", "minimum": 1}}, "required": ["browserName"]}, "screenResolution": {}, "env": {}, "numShards": {"type": "integer", "minimum": 0}, "shard": {"enum": ["", "concurrency", "spec"]}, "shardGrepEnabled": {"type": "boolean"}, "timeout": {}, "preExec": {}, "timeZone": {}, "passThreshold": {}, "smartRetry": {}}, "required": ["name", "params", "testMatch"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "playwright", "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 | playwright | Contains details specific to the Playwright project. | {"type": "object", "properties": {"version": {"enum": ["package.json", "1.36.2", "1.35.1", "1.33.0", "1.31.1", "1.29.2", "1.28.1", "1.27.1", "1.25.1", "1.24.1", "1.22.2"]}, "configFile": {"type": "string"}}, "required": ["version"], "additionalProperties": false} |
saucectl.schema.json | configFile | The path to playwright config file | {"type": "string"} |
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"}, "playwrightVersion": {}, "testMatch": {"type": "array"}, "excludedTestFiles": {"type": "array"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "params": {"type": "object", "properties": {"browserName": {"enum": ["chromium", "firefox", "webkit", "chrome"]}, "headless": {"type": "boolean"}, "globalTimeout": {"type": "integer"}, "timeout": {"type": "integer"}, "grep": {"type": "string"}, "grepInvert": {"type": "string"}, "repeatEach": {"type": "integer", "minimum": 0}, "retries": {"type": "integer", "minimum": 0}, "maxFailures": {"type": "integer", "minimum": 0}, "project": {"type": "string"}, "updateSnapshots": {"type": "boolean"}, "workers": {"type": "integer", "minimum": 1}}, "required": ["browserName"]}, "screenResolution": {}, "env": {}, "numShards": {"type": "integer", "minimum": 0}, "shard": {"enum": ["", "concurrency", "spec"]}, "shardGrepEnabled": {"type": "boolean"}, "timeout": {}, "preExec": {}, "timeZone": {}, "passThreshold": {}, "smartRetry": {}}, "required": ["name", "params", "testMatch"], "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 | testMatch | Paths to the playwright test files. Regex values are supported to indicate all files of a certain type or in a certain directory, etc. | {"type": "array"} |
saucectl.schema.json | excludedTestFiles | Exclude test files to skip the tests. | {"type": "array"} |
saucectl.schema.json | params | Details any additional parameters you wish to set for the test suite. | {"type": "object", "properties": {"browserName": {"enum": ["chromium", "firefox", "webkit", "chrome"]}, "headless": {"type": "boolean"}, "globalTimeout": {"type": "integer"}, "timeout": {"type": "integer"}, "grep": {"type": "string"}, "grepInvert": {"type": "string"}, "repeatEach": {"type": "integer", "minimum": 0}, "retries": {"type": "integer", "minimum": 0}, "maxFailures": {"type": "integer", "minimum": 0}, "project": {"type": "string"}, "updateSnapshots": {"type": "boolean"}, "workers": {"type": "integer", "minimum": 1}}, "required": ["browserName"]} |
saucectl.schema.json | headless | Run tests in headless mode. | {"type": "boolean"} |
saucectl.schema.json | globalTimeout | Total timeout in milliseconds for the whole test run. | {"type": "integer"} |
saucectl.schema.json | timeout | Changes the timeout for the test (milliseconds). | {"type": "integer"} |
saucectl.schema.json | grep | Patterns to run tests based on their title. | {"type": "string"} |
saucectl.schema.json | grepInvert | Patterns to skip tests based on their title. | {"type": "string"} |
saucectl.schema.json | repeatEach | The number of times to repeat each test. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | retries | The maximum number of retry attempts given to failed tests. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | maxFailures | The maximum number of test failures for this test run. After reaching this number, testing will stop and exit with an error. Setting to zero (default) disables this behavior. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | project | Specify playwright project | {"type": "string"} |
saucectl.schema.json | updateSnapshots | Whether to update expected snapshots with the actual results produced by the test run | {"type": "boolean"} |
saucectl.schema.json | workers | Set the maximum number of parallel worker processes (default: 1) | {"type": "integer", "minimum": 1} |
saucectl.schema.json | numShards | When sharding is configured, saucectl automatically creates the sharded jobs based on the number of shards you specify. For example, for a suite that specifies 2 shards, saucectl clones the suite and runs shard 1/2 on the first suite, and the other shard 2/2 on the identical clone suite. | {"type": "integer", "minimum": 0} |
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 grep/grepInvert, let saucectl filter specs before executing. | {"type": "boolean"} |
saucectl.schema.json | then | Configuration file for puppeteer-replay using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "puppeteer-replay"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "recordings": {"type": "array"}, "browserName": {"enum": ["chrome"]}, "browserVersion": {}, "platform": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "timeout": {}, "passThreshold": {}}, "required": ["name", "recordings"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "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 | suites | The set of properties providing details about the test suites to run. | {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "recordings": {"type": "array"}, "browserName": {"enum": ["chrome"]}, "browserVersion": {}, "platform": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "timeout": {}, "passThreshold": {}}, "required": ["name", "recordings"], "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 | recordings | Relative paths to the chrome devtools recordings. | {"type": "array"} |
saucectl.schema.json | platform | 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 | then | Configuration file for testcafe using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}, {}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "testcafe"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "env": {}, "rootDir": {}, "testcafe": {"type": "object", "properties": {"version": {"enum": ["package.json", "3.0.1", "2.6.2", "2.5.0", "2.3.1", "2.2.0", "2.1.0", "2.0.1", "2.0.0", "1.20.0", "1.19.0"]}}, "required": ["version"], "additionalProperties": false}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "browserName": {"enum": ["chrome", "firefox", "microsoftedge", "safari"]}, "browserVersion": {}, "browserArgs": {"type": "array", "examples": [["--no-sandbox"], ["--disable-features=site-per-process"]]}, "headless": {"type": "boolean"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "assertionTimeout": {"type": "integer", "minimum": 0}, "clientScripts": {"type": "array"}, "env": {}, "shard": {"enum": ["", "concurrency", "spec"]}, "compilerOptions": {"type": "object", "properties": {"typescript": {"type": "object", "properties": {"configPath": {"type": "string"}, "customCompilerModulePath": {"type": "string"}, "options": {"type": "object", "additionalProperties": true}}}}}, "disablePageCaching": {"type": "boolean"}, "disableScreenshots": {"type": "boolean"}, "disableVideo": {"type": "boolean"}, "filter": {"type": "object", "properties": {"test": {"type": "string"}, "testGrep": {"type": "string"}, "testMeta": {"type": "object"}, "fixture": {"type": "string"}, "fixtureGrep": {"type": "string"}, "fixtureMeta": {"type": "object"}}}, "pageLoadTimeout": {"type": "integer", "minimum": 0}, "quarantineMode": {"type": "object", "properties": {"successThreshold": {"type": "integer", "default": 3}, "attemptLimit": {"type": "integer", "default": 5}}}, "screenResolution": {}, "screenshots": {"type": "object", "properties": {"takeOnFails": {"type": "boolean"}, "fullPage": {"type": "boolean"}}, "additionalProperties": false}, "selectorTimeout": {"type": "integer", "minimum": 0}, "ajaxRequestTimeout": {"type": "integer", "minimum": 0}, "pageRequestTimeout": {"type": "integer", "minimum": 0}, "browserInitTimeout": {"type": "integer", "minimum": 0}, "testExecutionTimeout": {"type": "integer", "minimum": 0}, "runExecutionTimeout": {"type": "integer", "minimum": 0}, "simulators": {"type": "array", "items": {"properties": {"name": {"type": "string", "examples": ["iPhone 12 Simulator"]}, "orientation": {}, "platformName": {"enum": ["iOS"]}, "platformVersions": {"type": "array"}}, "additionalProperties": false}}, "skipJsErrors": {"type": "boolean"}, "skipUncaughtErrors": {"type": "boolean"}, "speed": {"type": "number", "minimum": 0.01, "maximum": 1}, "src": {"type": "array"}, "stopOnFirstFail": {"type": "boolean"}, "timeout": {}, "preExec": {}, "excludedTestFiles": {}, "timeZone": {}, "passThreshold": {}, "smartRetry": {}}, "required": ["name", "browserName", "src"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "testcafe", "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 | testcafe | Contains details specific to the TestCafe project. | {"type": "object", "properties": {"version": {"enum": ["package.json", "3.0.1", "2.6.2", "2.5.0", "2.3.1", "2.2.0", "2.1.0", "2.0.1", "2.0.0", "1.20.0", "1.19.0"]}}, "required": ["version"], "additionalProperties": false} |
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"}, "browserName": {"enum": ["chrome", "firefox", "microsoftedge", "safari"]}, "browserVersion": {}, "browserArgs": {"type": "array", "examples": [["--no-sandbox"], ["--disable-features=site-per-process"]]}, "headless": {"type": "boolean"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "assertionTimeout": {"type": "integer", "minimum": 0}, "clientScripts": {"type": "array"}, "env": {}, "shard": {"enum": ["", "concurrency", "spec"]}, "compilerOptions": {"type": "object", "properties": {"typescript": {"type": "object", "properties": {"configPath": {"type": "string"}, "customCompilerModulePath": {"type": "string"}, "options": {"type": "object", "additionalProperties": true}}}}}, "disablePageCaching": {"type": "boolean"}, "disableScreenshots": {"type": "boolean"}, "disableVideo": {"type": "boolean"}, "filter": {"type": "object", "properties": {"test": {"type": "string"}, "testGrep": {"type": "string"}, "testMeta": {"type": "object"}, "fixture": {"type": "string"}, "fixtureGrep": {"type": "string"}, "fixtureMeta": {"type": "object"}}}, "pageLoadTimeout": {"type": "integer", "minimum": 0}, "quarantineMode": {"type": "object", "properties": {"successThreshold": {"type": "integer", "default": 3}, "attemptLimit": {"type": "integer", "default": 5}}}, "screenResolution": {}, "screenshots": {"type": "object", "properties": {"takeOnFails": {"type": "boolean"}, "fullPage": {"type": "boolean"}}, "additionalProperties": false}, "selectorTimeout": {"type": "integer", "minimum": 0}, "ajaxRequestTimeout": {"type": "integer", "minimum": 0}, "pageRequestTimeout": {"type": "integer", "minimum": 0}, "browserInitTimeout": {"type": "integer", "minimum": 0}, "testExecutionTimeout": {"type": "integer", "minimum": 0}, "runExecutionTimeout": {"type": "integer", "minimum": 0}, "simulators": {"type": "array", "items": {"properties": {"name": {"type": "string", "examples": ["iPhone 12 Simulator"]}, "orientation": {}, "platformName": {"enum": ["iOS"]}, "platformVersions": {"type": "array"}}, "additionalProperties": false}}, "skipJsErrors": {"type": "boolean"}, "skipUncaughtErrors": {"type": "boolean"}, "speed": {"type": "number", "minimum": 0.01, "maximum": 1}, "src": {"type": "array"}, "stopOnFirstFail": {"type": "boolean"}, "timeout": {}, "preExec": {}, "excludedTestFiles": {}, "timeZone": {}, "passThreshold": {}, "smartRetry": {}}, "required": ["name", "browserName", "src"], "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 | browserArgs | Browser specific arguments. | {"type": "array", "examples": [["--no-sandbox"], ["--disable-features=site-per-process"]]} |
saucectl.schema.json | headless | Controls whether or not tests are run in headless mode (default: false) | {"type": "boolean"} |
saucectl.schema.json | assertionTimeout | Specifies the time (in milliseconds) TestCafe attempts to successfully execute an assertion if a selector property or a client function was passed as an actual value. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | clientScripts | Injects scripts into pages visited during the tests. | {"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 | compilerOptions | Specifies the typescript compiler options to be used when running the tests. | {"type": "object", "properties": {"typescript": {"type": "object", "properties": {"configPath": {"type": "string"}, "customCompilerModulePath": {"type": "string"}, "options": {"type": "object", "additionalProperties": true}}}}} |
saucectl.schema.json | typescript | Specifies the TypeScript options. | {"type": "object", "properties": {"configPath": {"type": "string"}, "customCompilerModulePath": {"type": "string"}, "options": {"type": "object", "additionalProperties": true}}} |
saucectl.schema.json | configPath | Specifies the path to the TypeScript tsconfig.json file. | {"type": "string"} |
saucectl.schema.json | customCompilerModulePath | Specifies the path to a custom TypeScript compiler module. | {"type": "string"} |
saucectl.schema.json | options | Specifies TypeScript compiler options. Full reference: https://www.typescriptlang.org/tsconfig#compilerOptions | {"type": "object", "additionalProperties": true} |
saucectl.schema.json | disablePageCaching | Prevents the browser from caching page content. | {"type": "boolean"} |
saucectl.schema.json | disableScreenshots | Prevents TestCafe from taking screenshots. | {"type": "boolean"} |
saucectl.schema.json | disableVideo | Disable video recording. | {"type": "boolean"} |
saucectl.schema.json | filter | Allows you to specify which tests or fixtures to run. | {"type": "object", "properties": {"test": {"type": "string"}, "testGrep": {"type": "string"}, "testMeta": {"type": "object"}, "fixture": {"type": "string"}, "fixtureGrep": {"type": "string"}, "fixtureMeta": {"type": "object"}}} |
saucectl.schema.json | test | Runs a test with the specified name. | {"type": "string"} |
saucectl.schema.json | testGrep | Runs tests whose names match the specified grep pattern. | {"type": "string"} |
saucectl.schema.json | testMeta | Runs tests whose metadata matches the specified key-value pair. | {"type": "object"} |
saucectl.schema.json | fixture | Runs a test with the specified fixture name. | {"type": "string"} |
saucectl.schema.json | fixtureGrep | Runs tests whose fixture names match the specified grep pattern. | {"type": "string"} |
saucectl.schema.json | fixtureMeta | Runs tests whose fixture’s metadata matches the specified key-value pair. | {"type": "object"} |
saucectl.schema.json | pageLoadTimeout | Specifies the time (in milliseconds) passed after the DOMContentLoaded event, within which TestCafe waits for the window.load event to fire.
After the timeout passes or the window.load event is raised (whichever happens first), TestCafe starts the test. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | quarantineMode | Enable quarantine mode to eliminate false negatives and detect unstable tests. TestCafe quarantines tests that fail, and repeats them until they yield conclusive results. | {"type": "object", "properties": {"successThreshold": {"type": "integer", "default": 3}, "attemptLimit": {"type": "integer", "default": 5}}} |
saucectl.schema.json | successThreshold | The number of successful attempts necessary to confirm a test’s success. The option value should be greater than 0. | {"type": "integer", "default": 3} |
saucectl.schema.json | attemptLimit | The maximum number of test execution attempts. The option value must be larger than the value of the successThreshold. | {"type": "integer", "default": 5} |
saucectl.schema.json | screenshots | Allows you to specify the screenshot options. | {"type": "object", "properties": {"takeOnFails": {"type": "boolean"}, "fullPage": {"type": "boolean"}}, "additionalProperties": false} |
saucectl.schema.json | takeOnFails | Specifies that a screenshot should be taken whenever a test fails. | {"type": "boolean"} |
saucectl.schema.json | fullPage | Specifies that the full page should be captured, including content that is not visible due to overflow. | {"type": "boolean"} |
saucectl.schema.json | selectorTimeout | Specifies the time (in milliseconds) within which selectors attempt to return a node. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | ajaxRequestTimeout | Specifies wait time (in milliseconds) for fetch/XHR requests. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | pageRequestTimeout | Specifies time (in milliseconds) to wait for HTML pages. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | browserInitTimeout | Time (in milliseconds) for browsers to connect to TestCafe and report that they are ready to test. | {"type": "integer", "minimum": 0} |
saucectl.schema.json | testExecutionTimeout | Maximum test execution time (in milliseconds). | {"type": "integer", "minimum": 0} |
saucectl.schema.json | runExecutionTimeout | Maximum test run execution time (in milliseconds). | {"type": "integer", "minimum": 0} |
saucectl.schema.json | simulators | Run tests against the simulators defined here. | {"type": "array", "items": {"properties": {"name": {"type": "string", "examples": ["iPhone 12 Simulator"]}, "orientation": {}, "platformName": {"enum": ["iOS"]}, "platformVersions": {"type": "array"}}, "additionalProperties": false}} |
saucectl.schema.json | name | The name of the simulator. | {"type": "string", "examples": ["iPhone 12 Simulator"]} |
saucectl.schema.json | platformName | The name of the simulator platform. | {"enum": ["iOS"]} |
saucectl.schema.json | platformVersions | Which platform versions (OS versions) should be used. Multiple values are treated as 'AND', thus tests run across multiple versions. | {"type": "array"} |
saucectl.schema.json | skipJsErrors | Determines whether to ignore JavaScript errors on a webpage. | {"type": "boolean"} |
saucectl.schema.json | skipUncaughtErrors | Ignores uncaught errors and unhandled promise rejections in test code. | {"type": "boolean"} |
saucectl.schema.json | speed | Specifies the test execution speed. Provide a number between 1 (the fastest) and 0.01 (the slowest). | {"type": "number", "minimum": 0.01, "maximum": 1} |
saucectl.schema.json | src | Specifies files or directories from which to run tests. | {"type": "array"} |
saucectl.schema.json | stopOnFirstFail | Stops a test run if a test fails. | {"type": "boolean"} |
saucectl.schema.json | then | Configuration file for xcuitest using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "xcuitest"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "xcuitest": {"type": "object", "properties": {"app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array"}}, "additionalProperties": false}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array"}, "testOptions": {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "testLanguage": {"type": "string"}, "testRegion": {"type": "string"}, "testTimeoutsEnabled": {"type": "string", "enum": ["Yes", "No"]}, "maximumTestExecutionTimeAllowance": {"type": "number"}, "defaultTestExecutionTimeAllowance": {"type": "number"}}, "additionalProperties": false}, "appSettings": {}, "simulators": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}}, "devices": {"type": "array", "items": {"properties": {"id": {"type": "string", "examples": ["iPhone_12_Pro_14_real", "iPhone_12_Pro_real_us"]}, "name": {"type": "string", "examples": ["iPad .*", "iPhone .*"]}, "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": {}, "passThreshold": {}, "smartRetry": {}, "shard": {"enum": ["", "concurrency"]}, "testListFile": {"type": "string"}}, "anyOf": [{"required": ["simulators"]}, {"required": ["devices"]}], "required": ["name"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "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 | xcuitest | Contains details specific to the XCUITest project. | {"type": "object", "properties": {"app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array"}}, "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. When targeting simulators, a maximum of 2 otherApps is supported. | {"type": "array"} |
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"}, "app": {"type": "string"}, "appDescription": {"type": "string"}, "testApp": {"type": "string"}, "testAppDescription": {"type": "string"}, "otherApps": {"type": "array"}, "testOptions": {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "testLanguage": {"type": "string"}, "testRegion": {"type": "string"}, "testTimeoutsEnabled": {"type": "string", "enum": ["Yes", "No"]}, "maximumTestExecutionTimeAllowance": {"type": "number"}, "defaultTestExecutionTimeAllowance": {"type": "number"}}, "additionalProperties": false}, "appSettings": {}, "simulators": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}}, "devices": {"type": "array", "items": {"properties": {"id": {"type": "string", "examples": ["iPhone_12_Pro_14_real", "iPhone_12_Pro_real_us"]}, "name": {"type": "string", "examples": ["iPad .*", "iPhone .*"]}, "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": {}, "passThreshold": {}, "smartRetry": {}, "shard": {"enum": ["", "concurrency"]}, "testListFile": {"type": "string"}}, "anyOf": [{"required": ["simulators"]}, {"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 | 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. When targeting simulators, a maximum of 2 otherApps is supported. | {"type": "array"} |
saucectl.schema.json | testOptions | Allows you to control various details on how tests are executed. | {"type": "object", "properties": {"class": {"type": "array"}, "notClass": {"type": "array"}, "testLanguage": {"type": "string"}, "testRegion": {"type": "string"}, "testTimeoutsEnabled": {"type": "string", "enum": ["Yes", "No"]}, "maximumTestExecutionTimeAllowance": {"type": "number"}, "defaultTestExecutionTimeAllowance": {"type": "number"}}, "additionalProperties": false} |
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 | testLanguage | Specifies ISO 639-1 language during testing. Supported on Simulators only. | {"type": "string"} |
saucectl.schema.json | testRegion | Specifies ISO 3166-1 region during testing. | {"type": "string"} |
saucectl.schema.json | testTimeoutsEnabled | By default there is no timeout, if enabled, then the timeout is 600 seconds. This can be changed by adding the defaultTestExecutionTimeAllowance value. Supported on Simulators only. | {"type": "string", "enum": ["Yes", "No"]} |
saucectl.schema.json | maximumTestExecutionTimeAllowance | The maximum execution time, in seconds, an individual test is given to execute, regardless of the test's preferred allowance. Supported on Simulators only. | {"type": "number"} |
saucectl.schema.json | defaultTestExecutionTimeAllowance | The default execution time, in seconds, an individual test is given to execute if test timeouts are enabled. Supported on Simulators only. | {"type": "number"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.