schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cluster.yml.json
cloud_provider
Cloud Provider options
{}
cluster.yml.json
prefix_path
kubernetes directory path
{"type": "string"}
cluster.yml.json
win_prefix_path
kubernetes directory path for windows
{"type": "string"}
cluster.yml.json
addon_job_timeout
Timeout in seconds for status check on addon deployment jobs
{"type": "integer"}
cluster.yml.json
bastion_host
Bastion/Jump Host configuration
{}
cluster.yml.json
monitoring
Monitoring Config
{}
cluster.yml.json
restore
RestoreCluster flag
{}
cluster.yml.json
rotate_certificates
Rotating Certificates Option
{}
cluster.yml.json
rotate_encryption_key
Rotate Encryption Key Option
{"type": "boolean"}
cluster.yml.json
dns
DNS Config
{}
cluster.yml.json
upgrade_strategy
Upgrade Strategy for the cluster
{}
cluster.yml.json
CACertificates
Rotate CA Certificates
{"type": "boolean"}
cluster.yml.json
Services
Services to rotate their certs
{"items": {"type": "string"}, "type": "array"}
cluster.yml.json
router-id
required
{"type": "string"}
cluster.yml.json
enabled
Enable/disable secrets encryption provider config
{"type": "boolean"}
cluster.yml.json
custom_config
Custom Encryption Provider configuration object
{}
cypress.schema.json
baseUrl
Url used as prefix for cy.visit() or cy.request() command’s url. Example http://localhost:3030 or https://test.my-domain.com
{"type": "string", "default": null}
cypress.schema.json
env
Any values to be set as environment variables. See https://on.cypress.io/environment-variables
{"type": "object", "body": {}}
cypress.schema.json
ignoreTestFiles
A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.
{"type": ["string", "array"], "items": {"type": "string"}}
cypress.schema.json
numTestsKeptInMemory
The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run.
{"type": "number", "default": 50}
cypress.schema.json
port
Port used to host Cypress. Normally this is a randomly generated port
{"type": "number", "default": null}
cypress.schema.json
reporter
The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters
{"type": "string", "default": "spec"}
cypress.schema.json
reporterOptions
The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options
{"type": "object", "default": null}
cypress.schema.json
slowTestThreshold
Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts
{"type": "number", "default": 10000}
cypress.schema.json
testFiles
A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global
{"type": ["string", "array"], "default": "**/*.*"}
cypress.schema.json
watchForFileChanges
Whether Cypress will watch and restart tests on test file changes
{"type": "boolean", "default": true}
cypress.schema.json
defaultCommandTimeout
Time, in milliseconds, to wait until most DOM based commands are considered timed out
{"type": "number", "default": 4000}
cypress.schema.json
execTimeout
Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command
{"type": "number", "default": 60000}
cypress.schema.json
taskTimeout
Time, in milliseconds, to wait for a task to finish executing during a cy.task() command
{"type": "number", "default": 60000}
cypress.schema.json
pageLoadTimeout
Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased.
{"type": "number", "default": 60000}
cypress.schema.json
requestTimeout
Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command
{"type": "number", "default": 5000}
cypress.schema.json
responseTimeout
Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands
{"type": "number", "default": 30000}
cypress.schema.json
fileServerFolder
Path to folder where application files will attempt to be served from
{"type": "string", "default": "root project folder"}
cypress.schema.json
fixturesFolder
Path to folder containing fixture files (Pass false to disable)
{"type": ["string", "boolean"], "default": "cypress/fixtures"}
cypress.schema.json
integrationFolder
Path to folder containing integration test files
{"type": "string", "default": "cypress/integration"}
cypress.schema.json
downloadsFolder
Path to folder where files downloaded during a test are saved
{"type": "string", "default": "cypress/downloads"}
cypress.schema.json
componentFolder
Path to folder containing component test files (Pass false to disable)
{"type": ["string", "boolean"], "default": false}
cypress.schema.json
pluginsFile
Path to plugins file. (Pass false to disable)
{"type": ["string", "boolean"], "default": "cypress/plugins/index.js"}
cypress.schema.json
screenshotOnRunFailure
Whether Cypress will take a screenshot when a test fails during cypress run
{"type": "boolean", "default": true}
cypress.schema.json
screenshotsFolder
Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run
{"type": "string", "default": "cypress/screenshots"}
cypress.schema.json
supportFile
Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)
{"type": ["string", "boolean"], "default": "cypress/support/index.js"}
cypress.schema.json
videosFolder
Path to folder where videos will be saved during cypress run
{"type": "string", "default": "cypress/videos"}
cypress.schema.json
trashAssetsBeforeRuns
Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run
{"type": "boolean", "default": true}
cypress.schema.json
videoCompression
The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size).
{"type": ["number", "boolean"], "default": 32}
cypress.schema.json
video
Whether Cypress will capture a video of the tests run with cypress run
{"type": "boolean", "default": true}
cypress.schema.json
videoUploadOnPasses
Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you’d like to only upload the spec file’s video when there are failing tests.
{"type": "boolean", "default": true}
cypress.schema.json
chromeWebSecurity
Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security
{"type": "boolean", "default": true}
cypress.schema.json
userAgent
Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
{"type": "string", "default": null}
cypress.schema.json
blockHosts
A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts
{"type": ["string", "array"], "items": {"type": "string"}, "default": null}
cypress.schema.json
modifyObstructiveCode
Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode
{"type": "boolean", "default": true}
cypress.schema.json
viewportHeight
Default height in pixels for the application under tests’ viewport (Override with cy.viewport() command)
{"type": "number", "default": 660}
cypress.schema.json
viewportWidth
Default width in pixels for the application under tests’ viewport. (Override with cy.viewport() command)
{"type": "number", "default": 1000}
cypress.schema.json
animationDistanceThreshold
The distance in pixels an element must exceed over time to be considered animating
{"type": "number", "default": 5}
cypress.schema.json
waitForAnimations
Whether to wait for elements to finish animating before executing commands
{"type": "boolean", "default": true}
cypress.schema.json
scrollBehavior
Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling.
{"enum": [false, "center", "top", "bottom", "nearest"], "default": "top"}
cypress.schema.json
projectId
A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification
{"type": "string", "default": null}
cypress.schema.json
nodeVersion
DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files.
{"enum": ["system", "bundled"], "default": "system"}
cypress.schema.json
experimentalInteractiveRunEvents
Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.
{"type": "boolean", "default": false}
cypress.schema.json
experimentalSourceRewriting
Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm.
{"type": "boolean", "default": false}
cypress.schema.json
experimentalSessionSupport
Enable experimental session support. See https://on.cypress.io/session
{"type": "boolean", "default": false}
cypress.schema.json
experimentalFetchPolyfill
Polyfills `window.fetch` to enable Network spying and stubbing
{"type": "boolean", "default": false}
cypress.schema.json
experimentalStudio
Generate and save commands directly to your test suite by interacting with your app as an end user would.
{"type": "boolean", "default": false}
cypress.schema.json
retries
The number of times to retry a failing. Can be configured to apply only in runMode or openMode
{"type": ["object", "number", "null"], "default": {"runMode": 0, "openMode": 0}}
cypress.schema.json
includeShadowDom
Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()
{"type": "boolean", "default": false}
cypress.schema.json
clientCertificates
Defines client certificates to use when sending requests to the specified URLs
{"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}, "ca": {"type": "array", "items": {"type": "string"}}, "certs": {"type": "array", "items": {"anyOf": [{"type": "object", "properties": {"cert": {"type": "string"}, "key": {"type": "string"}, "passphrase": {"type": "string"}}, "required": ["cert", "key"]}, {"type": "object", "properties": {"pfx": {"type": "string"}, "passphrase": {"type": "string"}}, "required": ["pfx"]}]}}}, "required": ["url", "certs"]}}
cypress.schema.json
url
Requests for URLs matching this minimatch pattern will use the supplied client certificate
{"type": "string"}
cypress.schema.json
ca
Path(s) to CA file(s) to validate certs against, relative to project root
{"type": "array", "items": {"type": "string"}}
cypress.schema.json
items
PEM file specific properties
{"type": "object", "properties": {"cert": {"type": "string"}, "key": {"type": "string"}, "passphrase": {"type": "string"}}, "required": ["cert", "key"]}
cypress.schema.json
cert
Path to the certificate, relative to project root
{"type": "string"}
cypress.schema.json
key
Path to the private key, relative to project root
{"type": "string"}
cypress.schema.json
passphrase
(Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root
{"type": "string"}
cypress.schema.json
items
PFX file specific properties
{"type": "object", "properties": {"pfx": {"type": "string"}, "passphrase": {"type": "string"}}, "required": ["pfx"]}
cypress.schema.json
pfx
Path to the certificate container, relative to project root
{"type": "string"}
cypress.schema.json
passphrase
(Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root
{"type": "string"}
cypress.schema.json
component
Any component runner specific overrides
{}
cypress.schema.json
e2e
Any e2e runner specific overrides
{}
tslint.json
severity
Severity level. Level "error" will cause exit code 2.
{"type": "string", "enum": ["default", "error", "warning", "warn", "off", "none"], "default": "default"}
tslint.json
align
Enforces vertical alignment.
{"definitions": {"options": {"type": "array", "items": {"type": "string", "enum": ["arguments", "elements", "members", "parameters", "statements"]}, "minItems": 1, "maxItems": 5, "uniqueItems": true}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 6, "uniqueItems": true, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
arrow-parens
Requires parentheses around the parameters of arrow function definitions.
{"definitions": {"options": {"type": "array", "items": {"type": "string", "enum": ["ban-single-arg-parens"]}, "minItems": 1, "maxItems": 1}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 2, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
arrow-return-shorthand
Suggests to convert `() => { return x; }` to `() => x`.
{"definitions": {"options": {"type": "array", "items": {"type": "string", "enum": ["multiline"]}, "minItems": 1, "maxItems": 1}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 2, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
ban
Bans the use of specific functions or global methods.
{"definitions": {"options": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": 3}, {"type": "object", "properties": {"name": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": 3}]}, "message": {"type": "string"}}, "required": ["name"], "additionalProperties": false}]}, "minItems": 1, "uniqueItems": true}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "uniqueItems": true, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
ban-comma-operator
Bans the comma operator.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
binary-expression-operand-order
In a binary expression, a literal should always be on the right-hand side if possible. For example, prefer 'x + 1' over '1 + x'.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
class-name
Enforces PascalCased class and interface names.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
comment-format
Enforces formatting rules for single-line comments.
{"definitions": {"options": {"type": "array", "items": {"anyOf": [{"type": "string", "enum": ["check-space", "check-lowercase", "check-uppercase"], "minItems": 1, "maxItems": 3, "uniqueItems": true}, {"type": "object", "properties": {"ignore-words": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "ignore-pattern": {"type": "string"}}, "minProperties": 1, "maxProperties": 1}]}, "minItems": 1, "maxItems": 4, "uniqueItems": true}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 5, "uniqueItems": true, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
completed-docs
Enforces documentation for important items be filled out.
{"definitions": {"options": {"type": "array", "items": {"oneOf": [{"type": "string", "enum": ["classes", "enums", "enum-members", "functions", "interfaces", "methods", "namespaces", "properties", "types", "variables"]}, {"type": "object", "properties": {"classes": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "enums": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "enum-members": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "functions": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "interfaces": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "methods": {"type": "object", "properties": {"locations": {"type": "string", "enum": ["all", "instance", "static"]}, "privacies": {"type": "string", "enum": ["all", "private", "protected", "public"]}}, "additionalProperties": false}, "namespaces": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "properties": {"type": "object", "properties": {"locations": {"type": "string", "enum": ["all", "instance", "static"]}, "privacies": {"type": "string", "enum": ["all", "private", "protected", "public"]}}, "additionalProperties": false}, "types": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}, "variables": {"type": "object", "properties": {"visibilities": {"type": "string", "enum": ["all", "exported", "internal"]}}, "additionalProperties": false}}}]}, "minItems": 1, "maxItems": 10, "uniqueItems": true}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 11, "uniqueItems": true, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
curly
Enforces braces for `if`/`for`/`do`/`while` statements.
{"definitions": {"options": {"type": "array", "items": {"type": "string", "enum": ["as-needed", "ignore-same-line"], "minItems": 1, "maxItems": 2, "uniqueItems": true}}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
cyclomatic-complexity
Enforces a threshold of cyclomatic complexity.
{"definitions": {"options": {"type": "array", "items": {"type": "number", "minimum": 2}, "minItems": 1, "maxItems": 1}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 2, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}
tslint.json
options
An option value or an array of multiple option values.
{"oneOf": [{}, {}]}
tslint.json
deprecation
Warns when deprecated APIs are used.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
encoding
Enforces UTF-8 file encoding.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
eofline
Ensures the file ends with a newline.
{"allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": false, "properties": {"severity": {}}, "additionalProperties": false}]}
tslint.json
file-header
Enforces a certain header comment for all files, matched by a regular expression.
{"definitions": {"options": {"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": 2}}, "allOf": [{}, {"items": [{"type": "boolean"}], "additionalItems": {}, "maxItems": 3, "properties": {"options": {"oneOf": [{}, {}]}, "severity": {}}, "additionalProperties": false}]}