schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
---|---|---|---|
workflow.json | produceeventdef | Produce an event and set its data | {"type": "object", "properties": {"eventRef": {"type": "string"}, "data": {"type": ["string", "object"]}, "contextAttributes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false, "required": ["eventRef"]} |
workflow.json | eventRef | References a name of a defined event | {"type": "string"} |
workflow.json | data | If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event. | {"type": ["string", "object"]} |
workflow.json | contextAttributes | Add additional event extension context attributes | {"type": "object", "additionalProperties": {"type": "string"}} |
workflow.json | input | Workflow expression to filter the state data input | {"type": "string"} |
workflow.json | output | Workflow expression that filters the state data output | {"type": "string"} |
workflow.json | useData | If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true. | {"type": "boolean", "default": true} |
workflow.json | data | Workflow expression that filters the received event payload (default: '${ . }') | {"type": "string"} |
workflow.json | toStateData | Workflow expression that selects a state data element to which the filtered event should be added/merged into. If not specified, denotes, the top-level state data element. | {"type": "string"} |
workflow.json | fromStateData | Workflow expression that selects state data that the state action can use | {"type": "string"} |
workflow.json | useResults | If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true. | {"type": "boolean", "default": true} |
workflow.json | results | Workflow expression that filters the actions data results | {"type": "string"} |
workflow.json | toStateData | Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element | {"type": "string"} |
workflow.json | validationSchema | URI of the JSON Schema used to validate the workflow | {"type": "string", "minLength": 1} |
workflow.json | validationSchema | Workflow data input schema definition | {"type": "object", "properties": {"schema": {"oneof": [{"type": "string", "minLength": 1}, {"type": "object", "$schema": "http://json-schema.org/draft-07/schema#"}]}, "failOnValidationErrors": {"type": "boolean", "default": true}}, "additionalProperties": false, "required": ["schema"]} |
workflow.json | oneof | URI of the JSON Schema used to validate the workflow | {"type": "string", "minLength": 1} |
workflow.json | oneof | The JSON Schema object used to validate the workflow | {"type": "object", "$schema": "http://json-schema.org/draft-07/schema#"} |
workflow.json | failOnValidationErrors | Determines if error should be thrown if there are validation errors | {"type": "boolean", "default": true} |
Butane-Schema.json | variant | Used to differentiate configs for different operating systems. Must be fcos for this specification. | {"type": "string", "enum": ["fcos"], "default": "fcos"} |
schema-table.json | type | The type of the field. | {"type": "string"} |
schema-table.json | default | Default value of the field. | {} |
bpkg.json | name | Where the dependency is located in `deps/`.
See more: https://github.com/bpkg/bpkg#name | {"type": "string", "default": ""} |
bpkg.json | version | The current version of the dependency.
See more: https://github.com/bpkg/bpkg#version-optional | {"type": "string", "default": "v0.1.0"} |
bpkg.json | description | Human-readable description of the functionality of the package.
See more: https://github.com/bpkg/bpkg#description | {"type": "string", "examples": ["Terminal utility functions"]} |
bpkg.json | global | Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing.
See more: https://github.com/bpkg/bpkg#global | {"type": "string", "default": "", "examples": ["true"]} |
bpkg.json | install | Shell script used to invoke in the install script. Required if package is being installed as a global script.
See more: https://github.com/bpkg/bpkg#install-1 | {"type": "string", "default": "make install", "examples": ["make install"]} |
bpkg.json | scripts | An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts | {"type": "array", "items": {"type": "string", "examples": ["script.sh"]}} |
bpkg.json | files | An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional | {"type": "array", "items": {"type": "string"}} |
bpkg.json | dependencies | Hash of dependencies of this project. Use either a tagged release identifier or `master`.
See more: https://github.com/bpkg/bpkg#dependencies-optional | {"type": "object", "additionalProperties": {"type": "string"}} |
bpkg.json | dependencies-dev | Hash of development dependencies of this project. Use either a tagged release identifier or `master`.
See more: https://github.com/bpkg/bpkg#dependencies-dev-optional | {"type": "object", "additionalProperties": {"type": "string"}} |
bpkg.json | commands | A hash of runnable commands for `bpkg run`.
See more: https://github.com/bpkg/bpkg#commands-optional | {"type": "object", "additionalProperties": {"type": "string"}} |
bpkg.json | commands-description | A hash of descriptions for each command in `commands`.
See more: https://github.com/bpkg/bpkg#commands-description-optional | {"type": "object", "additionalProperties": {"type": "string"}} |
strings.json | Strings of the current application
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "properties": {"usage": {"type": "string", "minLength": 1, "default": "Usage:"}, "options": {"type": "string", "minLength": 1, "default": "Options:"}, "arguments": {"type": "string", "minLength": 1, "default": "Arguments:"}, "commands": {"type": "string", "minLength": 1, "default": "Commands:"}, "examples": {"type": "string", "minLength": 1, "default": "Examples:"}, "environment_variables": {"type": "string", "minLength": 1, "default": "Environment Variables:"}, "group": {"type": "string", "minLength": 1, "default": "%{group} Commands:"}, "command_alias": {"type": "string", "minLength": 1, "default": "Alias: %{alias}"}, "default_command_summary": {"type": "string", "minLength": 1, "default": "%{summary} (default)"}, "required": {"type": "string", "minLength": 1, "default": "(required)"}, "repeatable": {"type": "string", "minLength": 1, "default": "(repeatable)"}, "default": {"type": "string", "minLength": 1, "default": "Default: %{value}"}, "allowed": {"type": "string", "minLength": 1, "default": "Allowed: %{values}"}, "help_flag_text": {"type": "string", "minLength": 1, "default": "Show this help"}, "version_flag_text": {"type": "string", "minLength": 1, "default": "Show version number"}, "flag_requires_an_argument": {"type": "string", "minLength": 1, "default": "%{name} requires an argument: %{usage}"}, "invalid_argument": {"type": "string", "minLength": 1, "default": "invalid argument: %s"}, "invalid_flag": {"type": "string", "minLength": 1, "default": "invalid option: %s"}, "invalid_command": {"type": "string", "minLength": 1, "default": "invalid command: %s"}, "conflicting_flags": {"type": "string", "minLength": 1, "default": "conflicting options: %s cannot be used with %s"}, "missing_required_argument": {"type": "string", "minLength": 1, "default": "missing required argument: %{arg}\\nusage: %{usage}"}, "missing_required_flag": {"type": "string", "minLength": 1, "default": "missing required flag: %{usage}"}, "missing_required_environment_variable": {"type": "string", "minLength": 1, "default": "missing required environment variable: %{var}"}, "missing_dependency": {"type": "string", "minLength": 1, "default": "missing dependency: %{dependency}"}, "disallowed_flag": {"type": "string", "minLength": 1, "default": "%{name} must be one of: %{allowed}"}, "disallowed_argument": {"type": "string", "minLength": 1, "default": "%{name} must be one of: %{allowed}"}, "unsupported_bash_version": {"type": "string", "minLength": 1, "default": "bash version 4 or higher is required"}, "validation_error": {"type": "string", "minLength": 1, "default": "validation error in %s:\\n%s"}}, "additionalProperties": false} |
|
strings.json | usage | A usage caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Usage:"} |
strings.json | options | An option caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Options:"} |
strings.json | arguments | An argument caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Arguments:"} |
strings.json | commands | A command caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Commands:"} |
strings.json | examples | An example caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Examples:"} |
strings.json | environment_variables | An environment variable caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Environment Variables:"} |
strings.json | group | A group caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "%{group} Commands:"} |
strings.json | command_alias | An alias helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Alias: %{alias}"} |
strings.json | default_command_summary | A default command summary helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "%{summary} (default)"} |
strings.json | required | A required helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "(required)"} |
strings.json | repeatable | A repeatable helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "(repeatable)"} |
strings.json | default | A default helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Default: %{value}"} |
strings.json | allowed | An allowed helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Allowed: %{values}"} |
strings.json | help_flag_text | A help flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Show this help"} |
strings.json | version_flag_text | A version flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "Show version number"} |
strings.json | flag_requires_an_argument | A missing flag argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "%{name} requires an argument: %{usage}"} |
strings.json | invalid_argument | An invalid argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "invalid argument: %s"} |
strings.json | invalid_flag | An invalid option error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "invalid option: %s"} |
strings.json | invalid_command | An invalid command error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "invalid command: %s"} |
strings.json | conflicting_flags | A conflicting options error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "conflicting options: %s cannot be used with %s"} |
strings.json | missing_required_argument | A missing required argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "missing required argument: %{arg}\\nusage: %{usage}"} |
strings.json | missing_required_flag | A missing required flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "missing required flag: %{usage}"} |
strings.json | missing_required_environment_variable | A missing required environment variable error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "missing required environment variable: %{var}"} |
strings.json | missing_dependency | A missing dependency error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "missing dependency: %{dependency}"} |
strings.json | disallowed_flag | A forbidden flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "%{name} must be one of: %{allowed}"} |
strings.json | disallowed_argument | A forbidden argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "%{name} must be one of: %{allowed}"} |
strings.json | unsupported_bash_version | An unsupported Bash version error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "bash version 4 or higher is required"} |
strings.json | validation_error | A validation error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings | {"type": "string", "minLength": 1, "default": "validation error in %s:\\n%s"} |
swa-cli.config.json | apiLocation | API folder or Azure Functions emulator address | {"type": "string"} |
swa-cli.config.json | apiPort | API backend port | {"type": "number"} |
swa-cli.config.json | appArtifactLocation | Location of the build output directory relative to the appLocation | {"type": "string"} |
swa-cli.config.json | appLocation | Location for the static app source code | {"type": "string"} |
swa-cli.config.json | devserverTimeout | Time to wait(in ms) for the dev server to start | {"type": "number"} |
swa-cli.config.json | host | CLI host address | {"type": "string"} |
swa-cli.config.json | port | set the cli port | {"type": "number"} |
swa-cli.config.json | run | Run a command at startup | {"type": "string"} |
swa-cli.config.json | ssl | Serve the app and API over HTTPS | {"type": "boolean"} |
swa-cli.config.json | sslCert | SSL certificate (.crt) to use for serving HTTPS | {"type": "string"} |
swa-cli.config.json | sslKey | SSL key (.key) to use for serving HTTPS | {"type": "string"} |
epr-manifest.json | path | Relative path to resource. | {"type": "string"} |
epr-manifest.json | regex | A regular expression for identifying paths to resources. | {"type": "string"} |
epr-manifest.json | allowData | Determines if data is allowed at this path. | {"type": "boolean"} |
epr-manifest.json | site | A fully qualified URL of your website. | {"type": "string", "format": "uri"} |
epr-manifest.json | maxAge | Set the max age HTTP cache expiration. | {"type": "integer"} |
tenants.json | The tenants configuration | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": {"type": "object"}} |
|
tenants.json | additionalProperties | The configuration of a tenant | {"type": "object"} |
nest-cli.json | CompilerOptions | A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details | {"type": "object", "default": {}, "properties": {"tsConfigPath": {"default": "tsconfig.build.json", "type": "string"}, "builder": {"default": "tsc", "type": "string", "enum": ["tsc", "webpack", "swc"]}, "typeCheck": {"default": false, "type": "boolean"}, "webpack": {"default": false, "type": "boolean"}, "webpackConfigPath": {"default": "webpack.config.js", "type": "string"}, "plugins": {"default": [], "type": "array", "items": {}}, "assets": {"default": [], "type": "array", "items": {}}, "watchAssets": {"default": false, "type": "boolean"}, "deleteOutDir": {"type": "boolean", "default": false}, "manualRestart": {"type": "boolean", "default": false}}, "additionalProperties": false} |
nest-cli.json | tsConfigPath | (monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file. | {"default": "tsconfig.build.json", "type": "string"} |
nest-cli.json | builder | Builder to be used (tsc, webpack, swc). For details on how to configure `SWC` see https://docs.nestjs.com/recipes/swc#getting-started | {"default": "tsc", "type": "string", "enum": ["tsc", "webpack", "swc"]} |
nest-cli.json | typeCheck | If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details. | {"default": false, "type": "boolean"} |
nest-cli.json | webpack | If true, use webpack compiler (deprecated option, use `builder` instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details. | {"default": false, "type": "boolean"} |
nest-cli.json | webpackConfigPath | Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js. | {"default": "webpack.config.js", "type": "string"} |
nest-cli.json | assets | Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details. | {"default": [], "type": "array", "items": {}} |
nest-cli.json | watchAssets | If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property. | {"default": false, "type": "boolean"} |
nest-cli.json | deleteOutDir | If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist). | {"type": "boolean", "default": false} |
nest-cli.json | manualRestart | If true, enables the shortcut `rs` to manually restart the server. | {"type": "boolean", "default": false} |
nest-cli.json | AssetsOptions | For finer control, the element can be object. | {"type": ["string", "object"], "properties": {"include": {"type": "string"}, "exclude": {"type": "string"}, "outDir": {"type": "string"}, "watchAssets": {"type": "boolean"}}, "additionalProperties": false} |
nest-cli.json | include | Glob-like file specifications for the assets to be distributed. | {"type": "string"} |
nest-cli.json | exclude | Glob-like file specifications for the assets to be excluded from the include list. | {"type": "string"} |
nest-cli.json | outDir | A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output. | {"type": "string"} |
nest-cli.json | watchAssets | If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property. | {"type": "boolean"} |
nest-cli.json | GenerateOptions | A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details | {"type": "object", "properties": {"spec": {}, "flat": {}, "baseDir": {}}, "default": {}, "additionalProperties": false} |
nest-cli.json | GenerateFlatOptions | If true, all generate commands will generate a flat structure | {"type": "boolean", "default": false} |
nest-cli.json | GenerateSpecOptions | If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details. | {"type": ["boolean", "object"], "properties": {"application": {"type": "boolean"}, "class": {"type": "boolean"}, "cl": {"type": "boolean"}, "configuration": {"type": "boolean"}, "config": {"type": "boolean"}, "controller": {"type": "boolean"}, "co": {"type": "boolean"}, "decorator": {"type": "boolean"}, "d": {"type": "boolean"}, "filter": {"type": "boolean"}, "f": {"type": "boolean"}, "gateway": {"type": "boolean"}, "ga": {"type": "boolean"}, "guard": {"type": "boolean"}, "gu": {"type": "boolean"}, "interceptor": {"type": "boolean"}, "in": {"type": "boolean"}, "interface": {"type": "boolean"}, "middleware": {"type": "boolean"}, "mi": {"type": "boolean"}, "module": {"type": "boolean"}, "mo": {"type": "boolean"}, "pipe": {"type": "boolean"}, "pi": {"type": "boolean"}, "provider": {"type": "boolean"}, "pr": {"type": "boolean"}, "resolver": {"type": "boolean"}, "r": {"type": "boolean"}, "service": {"type": "boolean"}, "s": {"type": "boolean"}, "library": {"type": "boolean"}, "lib": {"type": "boolean"}, "sub-app": {"type": "boolean"}, "app": {"type": "boolean"}, "resource": {"type": "boolean"}, "res": {"type": "boolean"}}, "additionalProperties": false} |
nest-cli.json | application | Generate spec file for application schematics or not. | {"type": "boolean"} |
nest-cli.json | class | Disable spec file generation for class schematics. | {"type": "boolean"} |
nest-cli.json | cl | Alias for class | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.