schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
up.json | items | A list of methods the client is allowed to use with cross-domain requests. | {"type": "string", "examples": ["GET", "HEAD"]} |
up.json | items | A list of headers the client is allowed to use with cross-domain requests. If the special `*` value is present in the list, all headers will be allowed. | {"type": "string", "examples": ["Content-Type"]} |
up.json | items | A list of headers which are safe to expose to the API of a CORS response. | {"type": "string", "examples": ["Content-Type"]} |
up.json | max_age | A number indicating how long (in seconds) the results of a preflight request can be cached. | {"type": "integer", "default": 0} |
up.json | allowed_credentials | A boolean indicating whether the request can include user credentials such as cookies, HTTP authentication or client side SSL certificates. Defaults to true. | {"type": "boolean", "default": true} |
up.json | name | Name of the action for reference from alert definitions. | {"type": "string", "examples": ["slack", "email.backend", "text.frontend", "text_frontend", "email.tj", "email tj", "Text backend team"]} |
up.json | type | Type of action to perform. | {"type": "string", "examples": ["email", "sms"]} |
up.json | items | Email addresses when using the email action. | {"type": "string", "examples": ["[email protected]"]} |
up.json | items | Phone numbers when using the sms action. | {"type": "string", "examples": ["+12508004123"]} |
up.json | metric | Name of the metric. | {"type": "string", "examples": ["http.count", "http.latency", "http.4xx", "http.5xx"]} |
up.json | statistic | Name of statistic to perform. | {"type": "string", "enum": ["min", "max", "avg", "sum", "count"], "examples": ["avg", "sum"]} |
up.json | threshold | Threshold which is compared to the operator. | {"type": "integer", "default": 0} |
up.json | action | Name of the action to perform. | {"type": "string", "examples": ["email.backend", "sms backend team"]} |
up.json | period | Period is the alert query time-span. | {"type": ["integer", "string"], "default": "1m"} |
up.json | evaluation_periods | Number of periods to evaluate over. | {"type": "integer", "default": 1} |
up.json | operator | Operator is the comparison operator. | {"type": "string", "default": ">", "enum": [">", "<", ">=", "<="]} |
up.json | namespace | Metric namespace. | {"type": "string", "examples": ["AWS/ApiGateway"]} |
up.json | description | Informative alert description, displayed in the email, sms, or slack. | {"type": "string", "examples": ["Huge traffic spike"]} |
up.json | disable | Disable the alert. | {"type": "boolean", "default": false} |
saucectl.schema.json | Configuration file for saucectl. | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"kind": {"enum": ["apitest", "cypress", "espresso", "imagerunner", "playwright", "puppeteer-replay", "testcafe", "xcuitest", "playwright-cucumberjs"]}}, "allOf": [{"if": {"properties": {"kind": {"const": "cypress"}, "apiVersion": {"const": "v1alpha"}}}, "then": {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true}, {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true}, {"$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", "us-east-4", "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}, {"$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}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "cypress"}, "showConsoleLog": {"type": "boolean"}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "rootDir": {"type": "string"}, "cypress": {"type": "object", "properties": {"configFile": {"type": "string", "examples": ["cypress.json"]}, "key": {"type": "string"}, "record": {"type": "boolean"}, "version": {"enum": ["package.json", "9.7.0", "8.6.0"]}, "reporters": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"name": {"type": "string", "examples": ["dot", "nyan"]}, "options": {}}, "additionalProperties": false}}}, "required": ["configFile", "version"], "additionalProperties": false}, "env": {"type": "object"}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "browser": {"enum": ["chrome", "firefox", "microsoftedge"]}, "browserVersion": {"type": "string"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {"type": "string"}, "config": {"type": "object", "properties": {"testFiles": {"type": "array"}, "excludedTestFiles": {}, "env": {}}, "required": ["testFiles"]}, "shard": {"enum": ["", "concurrency", "spec"]}, "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}}}, "required": ["apiVersion", "kind", "cypress", "suites"], "additionalProperties": true}}, {"if": {"properties": {"kind": {"const": "cypress"}, "apiVersion": {"const": "v1"}}}, "then": {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true}, {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true}, {"$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}, {"$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}], "properties": {"apiVersion": {"const": "v1"}, "kind": {"const": "cypress"}, "showConsoleLog": {"type": "boolean"}, "defaults": {"type": "object", "properties": {"timeout": {"type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": ["1h", "10m", "90s"]}}, "additionalProperties": false}, "rootDir": {"type": "string"}, "cypress": {"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}, "env": {"type": "object"}, "suites": {"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}}}, "required": ["apiVersion", "kind", "cypress", "suites"], "additionalProperties": true}}, {"if": {"properties": {"kind": {"const": "espresso"}}}, "then": {"$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}}, {"if": {"properties": {"kind": {"const": "playwright"}}}, "then": {"$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}}, {"if": {"properties": {"kind": {"const": "puppeteer-replay"}}}, "then": {"$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}}, {"if": {"properties": {"kind": {"const": "testcafe"}}}, "then": {"$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}}, {"if": {"properties": {"kind": {"const": "xcuitest"}}}, "then": {"$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}}, {"if": {"properties": {"kind": {"const": "apitest"}}}, "then": {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "apitest"}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "projectName": {"type": "string"}, "testMatch": {"type": "array"}, "tests": {"type": "array"}, "tags": {"type": "array"}, "useRemoteTests": {"type": "boolean"}}, "required": ["projectName", "name"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "suites"], "additionalProperties": true}}, {"if": {"properties": {"kind": {"const": "playwright-cucumberjs"}}}, "then": {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}, {}, {}, {}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "playwright-cucumberjs"}, "showConsoleLog": {}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "rootDir": {}, "playwright": {"type": "object", "properties": {"version": {}}, "required": ["version"], "additionalProperties": false}, "env": {}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "browserName": {}, "browserVersion": {}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {}, "env": {}, "options": {"type": "object", "properties": {"config": {"type": "string"}, "name": {"type": "string"}, "paths": {"type": "array"}, "excludedTestFiles": {}, "backtrace": {"type": "boolean"}, "require": {"type": "array"}, "import": {"type": "array"}, "tags": {"type": "array"}, "format": {"type": "array"}, "formatOptions": {"type": "array"}, "parallel": {"type": "integer"}}, "required": ["paths"]}, "shard": {"enum": ["", "concurrency", "spec"]}, "timeout": {}, "preExec": {}, "timeZone": {}, "passThreshold": {}, "smartRetry": {}}, "required": ["name"], "additionalProperties": false}}}, "required": ["apiVersion", "kind", "playwright", "suites"], "additionalProperties": true}}, {"if": {"properties": {"kind": {"const": "imagerunner"}}}, "then": {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{}], "definitions": {"sauce": {"type": "object", "properties": {"region": {"enum": ["us-west-1", "eu-central-1"]}, "tunnel": {"properties": {"name": {"type": "string"}, "owner": {"type": "string"}}, "required": ["name"], "additionalProperties": false}}}, "suite": {"type": "object", "properties": {"name": {"type": "string"}, "image": {"type": "string"}, "imagePullAuth": {"type": "object", "properties": {"user": {"type": "string"}, "token": {"type": "string"}}}, "entrypoint": {"type": "string"}, "files": {"type": "array", "items": {"type": "object", "properties": {"src": {"type": "string"}, "dst": {"type": "string"}}}}, "artifacts": {"type": "array", "items": {"type": "string"}}, "env": {"type": "object"}, "timeout": {"type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": ["1h", "10m", "90s"]}, "workload": {"enum": ["webdriver", "other"]}, "resourceProfile": {"pattern": "^c(\\d+)m(\\d+)$", "examples": ["c1m1", "c2m2", "c3m3"]}, "metadata": {"type": "object"}}, "required": ["name", "workload"]}}, "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "imagerunner"}, "sauce": {}, "defaults": {}, "suites": {"type": "array", "minItems": 1, "items": {}}}, "required": ["apiVersion", "kind", "suites"], "additionalProperties": true}}]} |
|
saucectl.schema.json | then | Configuration file for cypress using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true}, {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true}, {"$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", "us-east-4", "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}, {"$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}], "properties": {"apiVersion": {"const": "v1alpha"}, "kind": {"const": "cypress"}, "showConsoleLog": {"type": "boolean"}, "defaults": {"type": "object", "properties": {"timeout": {}}, "additionalProperties": false}, "rootDir": {"type": "string"}, "cypress": {"type": "object", "properties": {"configFile": {"type": "string", "examples": ["cypress.json"]}, "key": {"type": "string"}, "record": {"type": "boolean"}, "version": {"enum": ["package.json", "9.7.0", "8.6.0"]}, "reporters": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"name": {"type": "string", "examples": ["dot", "nyan"]}, "options": {}}, "additionalProperties": false}}}, "required": ["configFile", "version"], "additionalProperties": false}, "env": {"type": "object"}, "suites": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "browser": {"enum": ["chrome", "firefox", "microsoftedge"]}, "browserVersion": {"type": "string"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {"type": "string"}, "config": {"type": "object", "properties": {"testFiles": {"type": "array"}, "excludedTestFiles": {}, "env": {}}, "required": ["testFiles"]}, "shard": {"enum": ["", "concurrency", "spec"]}, "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}}}, "required": ["apiVersion", "kind", "cypress", "suites"], "additionalProperties": true} |
saucectl.schema.json | then | Subschema for controlling artifacts | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | artifacts | Manage test output, such as logs, videos, and screenshots. | {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false} |
saucectl.schema.json | cleanup | Whether to remove all contents of artifacts directory | {"type": "boolean"} |
saucectl.schema.json | download | Settings related to downloading test artifacts from Sauce Labs. | {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false} |
saucectl.schema.json | match | Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'. | {"type": "array"} |
saucectl.schema.json | when | Specifies when and under what circumstances to download artifacts. | {"enum": ["always", "fail", "never", "pass"]} |
saucectl.schema.json | directory | Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite. | {"type": "string"} |
saucectl.schema.json | then | Subschema for npm specific settings | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | npm | Settings specific to npm. | {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false} |
saucectl.schema.json | packages | Specifies any npm packages that are required to run tests. | {"type": "object"} |
saucectl.schema.json | dependencies | Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory. | {"type": "array"} |
saucectl.schema.json | registry | Override the default and official NPM registry URL with a custom one. | {"type": "string", "deprecated": true} |
saucectl.schema.json | strictSSL | Whether or not to do SSL key validation when making requests to the registry via https. | {"type": "boolean"} |
saucectl.schema.json | registries | Specify all the registries you want to configure | {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}} |
saucectl.schema.json | scope | Scope for the registry entry | {"type": "string"} |
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", "us-east-4", "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", "us-east-4", "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", "us-east-4", "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": {}}, "additionalProperties": false} |
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.json"]}, "key": {"type": "string"}, "record": {"type": "boolean"}, "version": {"enum": ["package.json", "9.7.0", "8.6.0"]}, "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. SauceCTL determines related files based on the location of the config file. By default saucectl defers to the test file location defined in cypress.json. | {"type": "string", "examples": ["cypress.json"]} |
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 | 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"]}, "browserVersion": {"type": "string"}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {"type": "string"}, "config": {"type": "object", "properties": {"testFiles": {"type": "array"}, "excludedTestFiles": {}, "env": {}}, "required": ["testFiles"]}, "shard": {"enum": ["", "concurrency", "spec"]}, "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 | browserVersion | Which version of the browser to use. | {"type": "string"} |
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": {"testFiles": {"type": "array"}, "excludedTestFiles": {}, "env": {}}, "required": ["testFiles"]} |
saucectl.schema.json | testFiles | One or more paths to the Cypress test files to run for this suite, if not otherwise specified explicitly in cypress.json. | {"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 | 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 cypress using saucectl | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [{"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true}, {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true}, {"$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}, {"$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}], "properties": {"apiVersion": {"const": "v1"}, "kind": {"const": "cypress"}, "showConsoleLog": {"type": "boolean"}, "defaults": {"type": "object", "properties": {"timeout": {"type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": ["1h", "10m", "90s"]}}, "additionalProperties": false}, "rootDir": {"type": "string"}, "cypress": {"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}, "env": {"type": "object"}, "suites": {"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}}}, "required": ["apiVersion", "kind", "cypress", "suites"], "additionalProperties": true} |
saucectl.schema.json | then | Subschema for controlling artifacts | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"artifacts": {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | artifacts | Manage test output, such as logs, videos, and screenshots. | {"type": "object", "properties": {"cleanup": {"type": "boolean"}, "download": {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false}}, "additionalProperties": false} |
saucectl.schema.json | cleanup | Whether to remove all contents of artifacts directory | {"type": "boolean"} |
saucectl.schema.json | download | Settings related to downloading test artifacts from Sauce Labs. | {"type": "object", "properties": {"match": {"type": "array"}, "when": {"enum": ["always", "fail", "never", "pass"]}, "directory": {"type": "string"}}, "required": ["when", "match", "directory"], "additionalProperties": false} |
saucectl.schema.json | match | Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'. | {"type": "array"} |
saucectl.schema.json | when | Specifies when and under what circumstances to download artifacts. | {"enum": ["always", "fail", "never", "pass"]} |
saucectl.schema.json | directory | Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite. | {"type": "string"} |
saucectl.schema.json | then | Subschema for npm specific settings | {"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {"npm": {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false}}, "additionalProperties": true} |
saucectl.schema.json | npm | Settings specific to npm. | {"type": "object", "properties": {"packages": {"type": "object"}, "dependencies": {"type": "array"}, "registry": {"type": "string", "deprecated": true}, "strictSSL": {"type": "boolean"}, "registries": {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}}}, "additionalProperties": false} |
saucectl.schema.json | packages | Specifies any npm packages that are required to run tests. | {"type": "object"} |
saucectl.schema.json | dependencies | Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory. | {"type": "array"} |
saucectl.schema.json | registry | Override the default and official NPM registry URL with a custom one. | {"type": "string", "deprecated": true} |
saucectl.schema.json | strictSSL | Whether or not to do SSL key validation when making requests to the registry via https. | {"type": "boolean"} |
saucectl.schema.json | registries | Specify all the registries you want to configure | {"type": "array", "minimum": 0, "items": {"type": "object", "properties": {"scope": {"type": "string"}, "url": {"type": "string"}, "authToken": {"type": "string"}}, "required": ["url"]}} |
saucectl.schema.json | scope | Scope for the registry entry | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.