schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
saucectl.schema.json
simulators
Defines details for running this suite on virtual devices using a simulator.
{"type": "array", "items": {"properties": {"name": {"type": "string"}, "orientation": {}, "platformVersions": {"type": "array", "minItems": 1}}, "required": ["name", "platformVersions"], "additionalProperties": false}}
saucectl.schema.json
name
The name of the simulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual).
{"type": "string"}
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": ["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": "bool...
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": ["iPhone_12_Pro_14_real", "iPhone_12_Pro_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": ["iPad .*", "iPhone .*"]}
saucectl.schema.json
platformVersion
The version of the iOS 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
shard
When shard is configured as concurrency, saucectl automatically splits the tests by concurrency so that they can easily run in parallel.
{"enum": ["", "concurrency"]}
saucectl.schema.json
testListFile
This file containing tests will be used in sharding by concurrency.
{"type": "string"}
saucectl.schema.json
then
Configuration file for api testing using saucectl
{"$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"...
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"}, "projectName": {"type": "string"}, "testMatch": {"type": "array"}, "tests": {"type": "array"}, "tags": {"type": "array"}, "useRemoteTests": {"type": "boolean"}}, "required": ["projectName", "name"], "additionalProper...
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
projectName
Your project's name.
{"type": "string"}
saucectl.schema.json
testMatch
{"type": "array"}
saucectl.schema.json
tests
A list of test IDs to run for the project defined by hookId.
{"type": "array"}
saucectl.schema.json
tags
A test tag to run for the project defined by hookId.
{"type": "array"}
saucectl.schema.json
useRemoteTests
Use tests stored in the cloud instead of the local ones.
{"type": "boolean"}
saucectl.schema.json
then
Configuration file for cucumber using saucectl
{"$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}, "roo...
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.
{"type": "object", "properties": {"version": {}}, "required": ["version"], "additionalProperties": false}
saucectl.schema.json
version
Which framework version to use.
{}
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": {}, "browserVersion": {}, "platformName": {"enum": ["macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11"]}, "screenResolution": {}, "env": {}, "options": {"type": "object", "properties": {...
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
browserName
The name of the browser in which to run the tests.
{}
saucectl.schema.json
options
Provides details related to the Cucumberjs test configuration.
{"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": ...
saucectl.schema.json
config
Provides the location of the configuration file.
{"type": "string"}
saucectl.schema.json
name
Regular expressions of which cucumber scenario names should match one of to be run.
{"type": "string"}
saucectl.schema.json
paths
Paths to where your feature files are.
{"type": "array"}
saucectl.schema.json
backtrace
Show the full backtrace for errors.
{"type": "boolean"}
saucectl.schema.json
require
Paths to where your support code is, for CommonJS.
{"type": "array"}
saucectl.schema.json
import
Paths to where your support code is, for ESM.
{"type": "array"}
saucectl.schema.json
tags
Tag expression to filter which scenarios should be run.
{"type": "array"}
saucectl.schema.json
format
Name/path and (optionally) output file path of each formatter to use.
{"type": "array"}
saucectl.schema.json
formatOptions
Options to be provided to cucumber formatters.
{"type": "array"}
saucectl.schema.json
parallel
Run tests in parallel with the given number of worker processes.
{"type": "integer"}
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
then
Configuration file for running container images using saucectl
{"$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"], "additional...
saucectl.schema.json
sauce
All settings related to how tests are run and identified in the Sauce Labs platform.
{"type": "object", "properties": {"region": {"enum": ["us-west-1", "eu-central-1"]}, "tunnel": {"properties": {"name": {"type": "string"}, "owner": {"type": "string"}}, "required": ["name"], "additionalProperties": false}}}
saucectl.schema.json
region
Which Sauce Labs data center to target.
{"enum": ["us-west-1", "eu-central-1"]}
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
suite
The set of properties providing details about how to run the container.
{"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":...
saucectl.schema.json
name
The name of the test suite.
{"type": "string"}
saucectl.schema.json
image
The name of the container image.
{"type": "string"}
saucectl.schema.json
imagePullAuth
Container registry credentials for accessing the image.
{"type": "object", "properties": {"user": {"type": "string"}, "token": {"type": "string"}}}
saucectl.schema.json
user
The username.
{"type": "string"}
saucectl.schema.json
token
The access token.
{"type": "string"}
saucectl.schema.json
entrypoint
The command line arguments to launch the image with.
{"type": "string"}
saucectl.schema.json
files
List of files that you'd like saucectl to upload and mount within the container.
{"type": "array", "items": {"type": "object", "properties": {"src": {"type": "string"}, "dst": {"type": "string"}}}}
saucectl.schema.json
src
Path to the local file.
{"type": "string"}
saucectl.schema.json
dst
Path within the container that the file should be mounted at.
{"type": "string"}
saucectl.schema.json
artifacts
List of file paths within the container to be made available as downloadable artifacts.
{"type": "array", "items": {"type": "string"}}
saucectl.schema.json
env
Set one or more environment variables.
{"type": "object"}
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
workload
Sets the kind of workload that is being executed
{"enum": ["webdriver", "other"]}
saucectl.schema.json
resourceProfile
Sets the CPU/memory limits of the container. Format is <CPU><level><mem><level>. Default to c1m1.
{"pattern": "^c(\\d+)m(\\d+)$", "examples": ["c1m1", "c2m2", "c3m3"]}
saucectl.schema.json
metadata
Supply additional metadata to your runner.
{"type": "object"}
saucectl.schema.json
defaults
Settings that are applied onto every suite as a default value.
{}
saucectl.schema.json
suites
List of suites
{"type": "array", "minItems": 1, "items": {}}
config.json
Spec contains pipeline configuration
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"name": {"type": "string"}, "pipelineid": {"type": "string"}, "autodiscovery": {"properties": {"crawlers": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"golang/gomod": {"$schema": "http://json-schema.org/draft-04/schema", "prop...
config.json
name
Name defines a pipeline name
{"type": "string"}
config.json
pipelineid
PipelineID allows to identify a full pipeline run, this value is propagated into each target if not defined at that level
{"type": "string"}
config.json
autodiscovery
AutoDiscovery defines parameters to the autodiscovery feature
{"properties": {"crawlers": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"golang/gomod": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"rootdir": {"type": "string"}, "ignore": {"items": {"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"t...
config.json
crawlers
Crawlers defines a map of crawler configuration where the key represent the crawler type
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"golang/gomod": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"rootdir": {"type": "string"}, "ignore": {"items": {"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "o...
config.json
golang/gomod
Spec defines the parameters which can be provided to the Golang autodiscovery builder.
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"rootdir": {"type": "string"}, "ignore": {"items": {"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "goversion": {"type": "string"}}, "additionalProperties": false, "type": "ob...
config.json
rootdir
rootDir defines the root directory used to recursively search for golang go.mod
{"type": "string"}
config.json
ignore
ignore allows to specify "rule" to ignore autodiscovery a specific go.mod rule
{"items": {"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "goversion": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}
config.json
items
MatchingRule allows to specifies rules to identify manifest
{"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "goversion": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
path
Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring.
{"type": "string"}
config.json
modules
Modules specifies a list of module pattern.
{"patternProperties": {".*": {"type": "string"}}, "type": "object"}
config.json
goversion
GoVersions specifies a list of version pattern.
{"type": "string"}
config.json
only
`only` allows to specify rule to "only" autodiscover manifest for a specific golang rule
{"items": {"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "goversion": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}
config.json
items
MatchingRule allows to specifies rules to identify manifest
{"properties": {"path": {"type": "string"}, "modules": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "goversion": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
path
Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring.
{"type": "string"}
config.json
modules
Modules specifies a list of module pattern.
{"patternProperties": {".*": {"type": "string"}}, "type": "object"}
config.json
goversion
GoVersions specifies a list of version pattern.
{"type": "string"}
config.json
versionfilter
`versionfilter` provides parameters to specify the version pattern to use when generating manifest. kind - semver versionfilter of kind `semver` uses semantic versioning as version filtering pattern accepts one of: `patch` - patch only update patch version `minor` - minor only update minor version ...
{"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}
config.json
kind
specifies the version kind such as semver, regex, or latest
{"type": "string"}
config.json
pattern
specifies the version pattern according the version kind
{"type": "string"}
config.json
strict
strict enforce strict versioning rule. Only used for semantic versioning at this time
{"type": "boolean"}
config.json
helm
Spec defines the Helm parameters.
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"auths": {"patternProperties": {".*": {"properties": {"username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}}, "additionalProperties": false, "type": "object"}}, "type": "object"}, "ignorecontainer": {"type": "bool...
config.json
auths
auths provides a map of registry credentials where the key is the registry URL without scheme if empty, updatecli relies on OCI credentials such as the one used by Docker.
{"patternProperties": {".*": {"properties": {"username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}}, "additionalProperties": false, "type": "object"}}, "type": "object"}
config.json
.*
InlineKeyChain defines a keychain with OCI registry credentials
{"properties": {"username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
username
username specifies the container registry username to use for authentication. compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with token
{"type": "string"}
config.json
password
password specifies the container registry password to use for authentication. Not compatible with token compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with token
{"type": "string"}
config.json
token
token specifies the container registry token to use for authentication. compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with username/password
{"type": "string"}
config.json
ignorecontainer
ignorecontainer disables OCI container tag update when set to true
{"type": "boolean"}
config.json
ignorechartdependency
ignorechartdependency disables Helm chart dependencies update when set to true
{"type": "boolean"}
config.json
ignore
Ignore specifies rule to ignore Helm chart update.
{"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}
config.json
items
MatchingRule allows to specifies rules to identify manifest
{"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
path
Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a subpart of the path.
{"type": "string"}
config.json
rootdir
rootdir defines the root directory used to recursively search for Helm Chart
{"type": "string"}
config.json
only
only specify required rule(s) to restrict Helm chart update.
{"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}
config.json
items
MatchingRule allows to specifies rules to identify manifest
{"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
path
Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a subpart of the path.
{"type": "string"}