schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
chisel-slices.json
mutate
A Starlark expression to modify the file contents.
{"type": "string", "examples": ["foo = content.read(\"/path/to/temporary/content\")"]}
chisel-slices.json
contents
Files to include in the slice. Supports glob patterns.
{"type": "object", "examples": [{"/lib*/ld*.so.*": {}}, {"/usr/share/nodejs/cjs-module-lexer/**": {}}, {"/path/to/moved/content": {"copy": "/bin/original"}}, {"/path/to/link": {"symlink": "/bin/mybin"}}, {"/path/to/new/dir": {"make": true}}, {"/path/to/file/with/text": {"text": "Some text"}}, {"/path/to/mutable/file/with/default/text": {"text": "FIXME", "mutable": true}}, {"/path/to/temporary/content": {"until": "mutate"}}], "patternProperties": {"^.+$": {"type": ["object", "null"], "additionalProperties": false, "properties": {"make": {"type": "boolean", "default": true}, "mode": {"type": "integer", "examples": ["0o755"]}, "copy": {"type": "string", "examples": ["/path/to/original/file.txt"]}, "text": {"type": "string", "examples": ["FIXME"]}, "symlink": {"type": "string", "examples": ["/path/to/source/file.txt"]}, "mutable": {"type": "boolean", "default": true}, "until": {"type": "string", "examples": ["mutate"], "default": "", "enum": ["", "mutate"]}, "arch": {"type": "array", "uniqueItems": true, "examples": [["amd64", "arm64"]], "items": {"type": "string", "examples": ["amd64", "i386", "armhf", "arm64", "powerpc", "ppc64el", "s390x", "riscv64"]}}}}}}
chisel-slices.json
^.+$
Path description.
{"type": ["object", "null"], "additionalProperties": false, "properties": {"make": {"type": "boolean", "default": true}, "mode": {"type": "integer", "examples": ["0o755"]}, "copy": {"type": "string", "examples": ["/path/to/original/file.txt"]}, "text": {"type": "string", "examples": ["FIXME"]}, "symlink": {"type": "string", "examples": ["/path/to/source/file.txt"]}, "mutable": {"type": "boolean", "default": true}, "until": {"type": "string", "examples": ["mutate"], "default": "", "enum": ["", "mutate"]}, "arch": {"type": "array", "uniqueItems": true, "examples": [["amd64", "arm64"]], "items": {"type": "string", "examples": ["amd64", "i386", "armhf", "arm64", "powerpc", "ppc64el", "s390x", "riscv64"]}}}}
chisel-slices.json
make
Make this file or directory if it does not already exist.
{"type": "boolean", "default": true}
chisel-slices.json
mode
File permissions to use.
{"type": "integer", "examples": ["0o755"]}
chisel-slices.json
copy
Copy this file or directory from this location.
{"type": "string", "examples": ["/path/to/original/file.txt"]}
chisel-slices.json
text
The contents of the file.
{"type": "string", "examples": ["FIXME"]}
chisel-slices.json
symlink
Make a symlink to this file or directory.
{"type": "string", "examples": ["/path/to/source/file.txt"]}
chisel-slices.json
mutable
If true, the file is mutable.
{"type": "boolean", "default": true}
chisel-slices.json
until
Only keep this file until this stage.
{"type": "string", "examples": ["mutate"], "default": "", "enum": ["", "mutate"]}
chisel-slices.json
arch
Only include this file on specific architectures.
{"type": "array", "uniqueItems": true, "examples": [["amd64", "arm64"]], "items": {"type": "string", "examples": ["amd64", "i386", "armhf", "arm64", "powerpc", "ppc64el", "s390x", "riscv64"]}}
dart-build.json
Configuration for Dart's build system
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"_listOfGlobs": {"type": "array", "items": {"type": "string"}}, "buildConfig": {"type": "object", "properties": {"targets": {"type": "object", "additionalProperties": {}, "propertyNames": {}}, "builders": {"type": "object", "additionalProperties": {}, "propertyNames": {}}, "post_process_builders": {"type": "object", "additionalProperties": {}}, "global_options": {"type": "object", "additionalProperties": {}}, "additional_public_assets": {}}, "additionalProperties": false}, "buildTarget": {"type": "object", "properties": {"auto_apply_builders": {"type": "boolean", "default": true}, "builders": {"type": "object", "propertyNames": {}, "additionalProperties": {}}, "dependencies": {"type": "array", "items": {}}, "sources": {}}, "additionalProperties": false}, "builderDefinition": {"type": "object", "properties": {"builder_factories": {"type": "array", "items": {"type": "string"}}, "import": {"type": "string"}, "build_extensions": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "auto_apply": {"default": "none"}, "required_inputs": {"type": "array", "items": {"type": "string"}}, "runs_before": {}, "applies_builders": {"type": "array", "items": {}}, "is_optional": {"type": "boolean", "default": false}, "build_to": {"default": "cache"}, "defaults": {}, "target": {"type": "string", "deprecated": true, "deprecationMessage": "May be null or unreliable and should not be used."}}, "additionalProperties": false}, "postProcessBuilderDefinition": {"type": "object", "properties": {"builder_factory": {"type": "string"}, "import": {"type": "string"}, "input_extensions": {"type": "array", "items": {"type": "string"}}, "defaults": {}}, "additionalProperties": false}, "inputSet": {"oneOf": [{"type": "object", "properties": {"include": {}, "exclude": {}}, "additionalProperties": false}, {}]}, "targetBuilderConfig": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "generate_for": {}, "options": {}, "dev_options": {}, "release_options": {}}, "additionalProperties": false}, "targetBuilderConfigDefaults": {"type": "object", "properties": {"generate_for": {}, "options": {}, "dev_options": {}, "release_options": {}}, "additionalProperties": false}, "globalBuilderOptions": {"type": "object", "properties": {"options": {}, "dev_options": {}, "release_options": {}, "runs_before": {}}, "additionalProperties": false}, "builderOptions": {"type": "object", "additionalProperties": true}, "autoApply": {"type": "string", "enum": ["none", "dependents", "all_packages", "root_package"]}, "buildTo": {"type": "string", "enum": ["cache", "source"]}, "targetKey": {"type": "string", "pattern": "^(?:\\w+:)?\\w+|\\$default$"}, "builderKey": {"type": "string", "pattern": "^(?:\\w*:)?\\w+$"}, "runsBefore": {"type": "array", "items": {}}}}
dart-build.json
builderOptions
An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.
{"type": "object", "additionalProperties": true}
dart-build.json
autoApply
On which packages the builder is applied by default
{"type": "string", "enum": ["none", "dependents", "all_packages", "root_package"]}
dart-build.json
buildTo
Whether the outputs should be stored in a hidden cache or in the source directory.
{"type": "string", "enum": ["cache", "source"]}
dart-build.json
targetKey
A target key has two parts, a package and a name. They are separated by a colon.
{"type": "string", "pattern": "^(?:\\w+:)?\\w+|\\$default$"}
dart-build.json
builderKey
To construct a key, you join the package name and the builder name with a colon.
{"type": "string", "pattern": "^(?:\\w*:)?\\w+$"}
server.schema.json
Configuration file for a CommandBox server
{"$schema": "http://json-schema.org/draft-06/schema#", "definitions": {"trayOptionsItem": {"type": "object", "properties": {"label": {"type": "string"}, "action": {"type": "string"}, "url": {"type": "string"}, "disabled": {"type": "boolean", "default": false}, "image": {"type": "string", "default": ""}, "hotkey": {"type": "string", "default": ""}, "path": {"type": "string", "default": ""}, "items": {"type": "array", "minItems": 0, "items": {}, "default": []}}}}, "type": "object", "properties": {"name": {"type": "string", "default": ""}, "openBrowser": {"type": "boolean", "default": true}, "openBrowserURL": {"type": "string", "default": ""}, "startTimeout": {"type": "number", "default": 240}, "stopsocket": {"type": "number", "default": 0}, "debug": {"type": "boolean", "default": false}, "trace": {"type": "boolean", "default": false}, "console": {"type": "boolean", "default": false}, "trayEnable": {"type": "boolean", "default": true}, "trayicon": {"type": "string", "default": ""}, "trayOptions": {"type": "array", "minItems": 0, "items": {}, "default": []}, "jvm": {"type": "object", "properties": {"heapSize": {"type": ["number", "string"], "default": ""}, "minHeapSize": {"type": ["number", "string"], "default": ""}, "args": {"type": "string", "default": ""}, "javaHome": {"type": "string", "default": ""}, "javaVersion": {"type": "string", "default": ""}}}, "web": {"type": "object", "properties": {"host": {"type": "string", "default": "127.0.0.1"}, "webroot": {"type": "string", "default": ""}, "directoryBrowsing": {"type": "boolean", "default": false}, "accessLogEnable": {"type": "boolean", "default": true}, "GZIPEnable": {"type": "boolean", "default": true}, "welcomeFiles": {"type": "string", "default": ""}, "aliases": {"type": "object", "patternProperties": {"^(/[^/]+)+$": {"type": "string"}}, "additionalProperties": false, "default": {}}, "errorPages": {"type": "object", "properties": {"default": {"type": "string", "default": ""}}, "patternProperties": {"^[1-5][0-9]{2}$": {"type": "string"}}, "additionalProperties": false, "default": {}}, "HTTP": {"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "port": {"type": "number", "default": 0}}}, "SSL": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 1443}, "certFile": {"type": "string", "default": ""}, "keyFile": {"type": "string", "default": ""}, "keyPass": {"type": "string", "default": ""}}}, "AJP": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 8009}}}, "rewrites": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "logEnable": {"type": "boolean", "default": false}, "config": {"type": "string", "default": ""}, "statusPath": {"type": "string", "default": "/tuckey-status"}, "configReloadSeconds": {"type": "number"}}}, "basicAuth": {"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "users": {"type": "object", "additionalProperties": {"type": "string"}, "default": {}}}}}}, "app": {"type": "object", "properties": {"logDir": {"type": "string", "default": ""}, "libDirs": {"type": "string", "default": ""}, "webConfigDir": {"type": "string", "default": ""}, "serverConfigDir": {"type": "string", "default": ""}, "webXML": {"type": "string", "default": ""}, "WARPath": {"type": "string", "default": ""}, "cfengine": {"type": "string", "default": ""}, "restMappings": {"type": "string", "default": ""}, "serverHomeDirectory": {"type": "string", "default": ""}, "sessionCookieSecure": {"type": "boolean", "default": false}, "sessionCookieHTTPOnly": {"type": "boolean", "default": false}}}, "runwar": {"type": "object", "properties": {"args": {"type": "string", "default": ""}}}}}
server.schema.json
trayOptionsItem
An object that represents a single tray menu item
{"type": "object", "properties": {"label": {"type": "string"}, "action": {"type": "string"}, "url": {"type": "string"}, "disabled": {"type": "boolean", "default": false}, "image": {"type": "string", "default": ""}, "hotkey": {"type": "string", "default": ""}, "path": {"type": "string", "default": ""}, "items": {"type": "array", "minItems": 0, "items": {}, "default": []}}}
server.schema.json
label
Text of menu item
{"type": "string"}
server.schema.json
action
Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'
{"type": "string"}
server.schema.json
url
Url to open for 'openbrowser' action
{"type": "string"}
server.schema.json
disabled
Turn menu item grey and nothing happens when clicking on it
{"type": "boolean", "default": false}
server.schema.json
image
Path to PNG image to display on menu item next to the label
{"type": "string", "default": ""}
server.schema.json
hotkey
Keyboard shortcut to choose this menu item
{"type": "string", "default": ""}
server.schema.json
path
Filesystem path to open for 'openfilesystem' action
{"type": "string", "default": ""}
server.schema.json
items
Nested menu items
{"type": "array", "minItems": 0, "items": {}, "default": []}
server.schema.json
name
The name of the server
{"type": "string", "default": ""}
server.schema.json
openBrowser
Controls whether browser opens by default when starting server
{"type": "boolean", "default": true}
server.schema.json
openBrowserURL
Override the URL to open when starting the server
{"type": "string", "default": ""}
server.schema.json
startTimeout
The length of time in seconds to wait for the server to start
{"type": "number", "default": 240}
server.schema.json
stopsocket
The port the server listens on to receive a stop command
{"type": "number", "default": 0}
server.schema.json
debug
Enable debug level logging for server
{"type": "boolean", "default": false}
server.schema.json
trace
Enable trace level logging for server
{"type": "boolean", "default": false}
server.schema.json
console
Start the server in console mode instead of in the background
{"type": "boolean", "default": false}
server.schema.json
trayEnable
Control whether the server has an associated icon in the system tray
{"type": "boolean", "default": true}
server.schema.json
trayicon
Path to the server's tray icon
{"type": "string", "default": ""}
server.schema.json
trayOptions
An array of custom menu items to be added to the server's tray menu
{"type": "array", "minItems": 0, "items": {}, "default": []}
server.schema.json
jvm
JVM Options
{"type": "object", "properties": {"heapSize": {"type": ["number", "string"], "default": ""}, "minHeapSize": {"type": ["number", "string"], "default": ""}, "args": {"type": "string", "default": ""}, "javaHome": {"type": "string", "default": ""}, "javaVersion": {"type": "string", "default": ""}}}
server.schema.json
heapSize
The max heap size of the server
{"type": ["number", "string"], "default": ""}
server.schema.json
minHeapSize
The starting heap size for the server
{"type": ["number", "string"], "default": ""}
server.schema.json
args
Ad-hoc JVM args for the server such as -X:name
{"type": "string", "default": ""}
server.schema.json
javaHome
Path to custom JRE. Default is the one that the CommandBox CLI is using
{"type": "string", "default": ""}
server.schema.json
javaVersion
A Java installation ID. In its entirety, it has the form <version>_<type>_<arch>_<os>_<jvm-implementation>_<release>
{"type": "string", "default": ""}
server.schema.json
web
Web Server Options
{"type": "object", "properties": {"host": {"type": "string", "default": "127.0.0.1"}, "webroot": {"type": "string", "default": ""}, "directoryBrowsing": {"type": "boolean", "default": false}, "accessLogEnable": {"type": "boolean", "default": true}, "GZIPEnable": {"type": "boolean", "default": true}, "welcomeFiles": {"type": "string", "default": ""}, "aliases": {"type": "object", "patternProperties": {"^(/[^/]+)+$": {"type": "string"}}, "additionalProperties": false, "default": {}}, "errorPages": {"type": "object", "properties": {"default": {"type": "string", "default": ""}}, "patternProperties": {"^[1-5][0-9]{2}$": {"type": "string"}}, "additionalProperties": false, "default": {}}, "HTTP": {"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "port": {"type": "number", "default": 0}}}, "SSL": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 1443}, "certFile": {"type": "string", "default": ""}, "keyFile": {"type": "string", "default": ""}, "keyPass": {"type": "string", "default": ""}}}, "AJP": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 8009}}}, "rewrites": {"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "logEnable": {"type": "boolean", "default": false}, "config": {"type": "string", "default": ""}, "statusPath": {"type": "string", "default": "/tuckey-status"}, "configReloadSeconds": {"type": "number"}}}, "basicAuth": {"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "users": {"type": "object", "additionalProperties": {"type": "string"}, "default": {}}}}}}
server.schema.json
host
The default host name of the server
{"type": "string", "default": "127.0.0.1"}
server.schema.json
webroot
Webroot directory
{"type": "string", "default": ""}
server.schema.json
directoryBrowsing
Enables file listing for directories with no welcome file
{"type": "boolean", "default": false}
server.schema.json
accessLogEnable
Enable web server access log
{"type": "boolean", "default": true}
server.schema.json
GZIPEnable
Enable GZip compression in HTTP responses
{"type": "boolean", "default": true}
server.schema.json
welcomeFiles
A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory
{"type": "string", "default": ""}
server.schema.json
aliases
Web aliases for the web server, similar to virtual directories
{"type": "object", "patternProperties": {"^(/[^/]+)+$": {"type": "string"}}, "additionalProperties": false, "default": {}}
server.schema.json
^(/[^/]+)+$
The key is the web-accessible virtual path and the value is the relative or absolute path to the folder the alias points to
{"type": "string"}
server.schema.json
errorPages
The error pages that CommandBox servers return. You can have a setting for each status code including a default error page to be used if no other setting applies
{"type": "object", "properties": {"default": {"type": "string", "default": ""}}, "patternProperties": {"^[1-5][0-9]{2}$": {"type": "string"}}, "additionalProperties": false, "default": {}}
server.schema.json
default
Path to default error page
{"type": "string", "default": ""}
server.schema.json
^[1-5][0-9]{2}$
The key is the status code integer and the value is a relative (to the web root) path to be loaded for that status code
{"type": "string"}
server.schema.json
HTTP
Configure the HTTP listener on the server
{"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "port": {"type": "number", "default": 0}}}
server.schema.json
enable
Enable HTTP for this serer
{"type": "boolean", "default": true}
server.schema.json
port
HTTP port to use
{"type": "number", "default": 0}
server.schema.json
SSL
Configure the HTTPS listener on the server
{"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 1443}, "certFile": {"type": "string", "default": ""}, "keyFile": {"type": "string", "default": ""}, "keyPass": {"type": "string", "default": ""}}}
server.schema.json
enable
Enable HTTPS for this server
{"type": "boolean", "default": false}
server.schema.json
port
HTTPS port to use
{"type": "number", "default": 1443}
server.schema.json
certFile
Path to SSL cert file
{"type": "string", "default": ""}
server.schema.json
keyFile
Path to SSL key file
{"type": "string", "default": ""}
server.schema.json
keyPass
Password for SSL key file
{"type": "string", "default": ""}
server.schema.json
AJP
Configure the AJP listener on the server
{"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "port": {"type": "number", "default": 8009}}}
server.schema.json
enable
Enable AJP for this server
{"type": "boolean", "default": false}
server.schema.json
port
AJP port to use
{"type": "number", "default": 8009}
server.schema.json
rewrites
Configure URL Rewrites
{"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "logEnable": {"type": "boolean", "default": false}, "config": {"type": "string", "default": ""}, "statusPath": {"type": "string", "default": "/tuckey-status"}, "configReloadSeconds": {"type": "number"}}}
server.schema.json
enable
Enable URL Rewrites on this server
{"type": "boolean", "default": false}
server.schema.json
logEnable
Enable Rewrite log file
{"type": "boolean", "default": false}
server.schema.json
config
Path to xml config file or .htaccess
{"type": "string", "default": ""}
server.schema.json
statusPath
URL path to visit Tuckey status page like '/tuckey-status'
{"type": "string", "default": "/tuckey-status"}
server.schema.json
configReloadSeconds
Number of seconds to check rewrite config file for changes
{"type": "number"}
server.schema.json
basicAuth
{"type": "object", "properties": {"enable": {"type": "boolean", "default": true}, "users": {"type": "object", "additionalProperties": {"type": "string"}, "default": {}}}}
server.schema.json
enable
Enable basic auth for this server
{"type": "boolean", "default": true}
server.schema.json
users
Users who can authenticate to basic auth
{"type": "object", "additionalProperties": {"type": "string"}, "default": {}}
server.schema.json
additionalProperties
The key is the user name and the value is the password.
{"type": "string"}
server.schema.json
app
Application Server Options
{"type": "object", "properties": {"logDir": {"type": "string", "default": ""}, "libDirs": {"type": "string", "default": ""}, "webConfigDir": {"type": "string", "default": ""}, "serverConfigDir": {"type": "string", "default": ""}, "webXML": {"type": "string", "default": ""}, "WARPath": {"type": "string", "default": ""}, "cfengine": {"type": "string", "default": ""}, "restMappings": {"type": "string", "default": ""}, "serverHomeDirectory": {"type": "string", "default": ""}, "sessionCookieSecure": {"type": "boolean", "default": false}, "sessionCookieHTTPOnly": {"type": "boolean", "default": false}}}
server.schema.json
logDir
The folder path where the servlet out, rewrite, and access log are written to
{"type": "string", "default": ""}
server.schema.json
libDirs
A comma-delimited list of directories from which CommandBox will load JARs
{"type": "string", "default": ""}
server.schema.json
webConfigDir
Directory for Lucee/Railo web context
{"type": "string", "default": ""}
server.schema.json
serverConfigDir
Directory for Lucee/Railo server context
{"type": "string", "default": ""}
server.schema.json
webXML
Path to web.xml file
{"type": "string", "default": ""}
server.schema.json
WARPath
Path to a local WAR archive or exploded WAR folder. Mutually exclusive with cfengine.
{"type": "string", "default": ""}
server.schema.json
cfengine
An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'
{"type": "string", "default": ""}
server.schema.json
restMappings
Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/*,/api/*'
{"type": "string", "default": ""}
server.schema.json
serverHomeDirectory
Path to folder where the server WAR will be expanded
{"type": "string", "default": ""}
server.schema.json
sessionCookieSecure
Enable secure session cookies
{"type": "boolean", "default": false}
server.schema.json
sessionCookieHTTPOnly
Enable HTTP-only session cookies
{"type": "boolean", "default": false}
server.schema.json
runwar
These settings apply to the underlying Runwar library that starts servers
{"type": "object", "properties": {"args": {"type": "string", "default": ""}}}
server.schema.json
args
Ad-hoc options for the underlying Runwar library
{"type": "string", "default": ""}
trivia.schema.json
AUTHOR
Author of the Trivia list.
{"type": "string"}
trivia.schema.json
CONFIG
The configuration for a trivia session.
{"type": "object", "properties": {"bot_plays": {"type": "boolean"}, "delay": {"type": "number", "minimum": 4.0}, "max_score": {"type": "integer", "exclusiveMinimum": 0}, "payout_multiplier": {"type": "number", "minimum": 0}, "reveal_answer": {"type": "boolean"}, "timeout": {"type": "number", "exclusiveMinimum": 0}, "use_spoilers": {"type": "boolean"}}, "additionalProperties": false}
trivia.schema.json
bot_plays
Whether or not the bot gains points during the session.
{"type": "boolean"}
trivia.schema.json
delay
The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.
{"type": "number", "minimum": 4.0}
trivia.schema.json
max_score
Number of points required in order to win the trivia, must be a positive integer.
{"type": "integer", "exclusiveMinimum": 0}
trivia.schema.json
payout_multiplier
The payout multiplier, must be a positive number or zero.
{"type": "number", "minimum": 0}
trivia.schema.json
reveal_answer
Whether or not to reveal the answer when the question times out.
{"type": "boolean"}
trivia.schema.json
timeout
Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.
{"type": "number", "exclusiveMinimum": 0}