server.schema.json

title: Tray Option

description: An object that represents a single tray menu item

title: Label

description: Text of menu item

title: Action

description: Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'

title: URL

description: Url to open for 'openbrowser' action

title: Disabled

description: Turn menu item grey and nothing happens when clicking on it

title: Image

description: Path to PNG image to display on menu item next to the label

title: Hotkey

description: Keyboard shortcut to choose this menu item

title: Path

description: Filesystem path to open for 'openfilesystem' action

title: Items

description: Nested menu items

$ref: #/definitions/trayOptionsItem

title: CommandBox Server

description: Configuration file for a CommandBox server

title: Name

description: The name of the server

title: Open Browser

description: Controls whether browser opens by default when starting server

title: Open Browser URL

description: Override the URL to open when starting the server

title: Server start timeout

description: The length of time in seconds to wait for the server to start

title: Stop Socket

description: The port the server listens on to receive a stop command

title: Debug

description: Enable debug level logging for server

title: Trace

description: Enable trace level logging for server

title: Console

description: Start the server in console mode instead of in the background

title: Tray Enable

description: Control whether the server has an associated icon in the system tray

title: Tray Icon

description: Path to the server's tray icon

title: Tray Options

description: An array of custom menu items to be added to the server's tray menu

title: JVM

description: JVM Options

title: Max Heap Size

description: The max heap size of the server

type: number string

title: Min Heap Size

description: The starting heap size for the server

title: JVM Arguments

description: Ad-hoc JVM args for the server such as -X:name

title: Java Home Path

description: Path to custom JRE. Default is the one that the CommandBox CLI is using

title: Java Version

description: A Java installation ID. In its entirety, it has the form <version>_<type>_<arch>_<os>_<jvm-implementation>_<release>

title: Web

description: Web Server Options

title: Host

description: The default host name of the server

title: Webroot

description: Webroot directory

title: Directory Browsing

description: Enables file listing for directories with no welcome file

title: Access Log Enable

description: Enable web server access log

title: GZIP Enable

description: Enable GZip compression in HTTP responses

title: Welcome Files

description: A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory

title: Aliases

description: Web aliases for the web server, similar to virtual directories

title: Alias

description: The key is the web-accessible virtual path and the value is the relative or absolute path to the folder the alias points to

title: Error Pages

description: 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

title: Default

description: Path to default error page

title: Error Page

description: 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

title: HTTP Settings

description: Configure the HTTP listener on the server

title: Enable

description: Enable HTTP for this serer

title: Port

description: HTTP port to use

title: SSL

description: Configure the HTTPS listener on the server

title: Enable

description: Enable HTTPS for this server

title: Port

description: HTTPS port to use

title: Cert File

description: Path to SSL cert file

title: Key File

description: Path to SSL key file

title: Key Pass

description: Password for SSL key file

title: AJP

description: Configure the AJP listener on the server

title: Enable

description: Enable AJP for this server

title: Port

description: AJP port to use

title: Rewrites

description: Configure URL Rewrites

title: Enable

description: Enable URL Rewrites on this server

title: Log Enable

description: Enable Rewrite log file

title: Config

description: Path to xml config file or .htaccess

title: Tuckey Status Path

description: URL path to visit Tuckey status page like '/tuckey-status'

default: /tuckey-status

title: Config Reload Seconds

description: Number of seconds to check rewrite config file for changes

title: Configure basic authentication

title: Enable

description: Enable basic auth for this server

title: Users

description: Users who can authenticate to basic auth

title: User

description: The key is the user name and the value is the password.

title: Application

description: Application Server Options

title: Log Directory

description: The folder path where the servlet out, rewrite, and access log are written to

title: Jar lib Directories

description: A comma-delimited list of directories from which CommandBox will load JARs

title: Web Context Directory

description: Directory for Lucee/Railo web context

title: Server Context Directory

description: Directory for Lucee/Railo server context

title: Web XML

description: Path to web.xml file

title: WAR Path

description: Path to a local WAR archive or exploded WAR folder.  Mutually exclusive with cfengine.

title: CFML Engine

description: An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'

title: REST Mappings

description: Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/*,/api/*'

title: Server Home Directory

description: Path to folder where the server WAR will be expanded

title: Session Cookie Secure

description: Enable secure session cookies

title: Session Cookie HttpOnly

description: Enable HTTP-only session cookies

title: Configure RunWar

description: These settings apply to the underlying Runwar library that starts servers

title: Arguments

description: Ad-hoc options for the underlying Runwar library


cspell.schema.json

enum: legacy universal

type: string

$ref: #/definitions/CacheFormat

default: legacy

description:
Format of the cache file.
- `legacy` - use absolute paths in the cache file
- `universal` - use a sharable format.

$ref: #/definitions/FSPathResolvable

description:
Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.

A prefix of `${cwd}` is replaced with the current working directory.

$ref: #/definitions/CacheStrategy

default: metadata

description: Strategy to use for detecting changed files, default: metadata

description: Store the results of processed files in order to only operate on the changed ones.

type: boolean

type: object

description:
The Strategy to use to detect if a file has changed.
- `metadata` - uses the file system timestamp and size to detect changes (fastest).
- `content` - uses a hash of the file content to check file changes (slower - more accurate).

enum: metadata content

description:
This is a set of characters that can include `-` or `|`
- `-` - indicates a range of characters: `a-c` => `abc`
- `|` - is a group separator, indicating that the characters on either side    are not related.

$ref: #/definitions/CharacterSet

description: the cost to insert / delete / replace / swap the characters in a group

type: number

description: The penalty cost to apply if the accent is used. This is used to discourage

required: characters cost

description: A description to describe the purpose of the map.

description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.

description:
The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a `|` to separate them.

Example: `"eéê|aåá"` contains two different sets.

To add a multi-character substring use `()`.

Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.

- To match the beginning of a word, use `^`: `"(^I)""`.
- To match the end of a word, use `$`: `"(e$)(ing$)"`.

description:
Add a penalty to the final cost. This is used to discourage certain suggestions.

Example: ```yaml # Match adding/removing `-` to the end of a word. map: "$(-$)" replace: 50 penalty: 100 ```

This makes adding a `-` to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.

description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.

required: insDel map

required: map replace

required: map swap

$ref: #/definitions/FsDictionaryPath

description: A File System Path to a dictionary file.

description: Specifies the scope of a dictionary.

enum: user workspace folder

description: Only for legacy dictionary definitions.

description: Optional description.

$ref: #/definitions/DictionaryPath

deprecationMessage: Use `path` instead.

description: Path to the file, only for legacy dictionary definitions.

$ref: #/definitions/DictionaryId

description:
This is the name of a dictionary.

Name Format:
- Must contain at least 1 number or letter.
- Spaces are allowed.
- Leading and trailing space will be removed.
- Names ARE case-sensitive.
- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.

description:
Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.

$ref: #/definitions/ReplaceMap

description: Replacement pairs.

$ref: #/definitions/DictionaryFileTypes

default: S

description: Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules.

description: Use Compounds.

required: file name

description: Used to provide extra data related to the dictionary

description: Optional description.

$ref: #/definitions/DictionaryInformation

description: Path to the file.

description: Replacement pairs.

description: Use Compounds.

required: name path

description: For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file. Note: only plain text files with one word per line are supported at this moment.

description: When `true`, let's the spell checker know that words can be added to this dictionary.

description: Optional description.

$ref: #/definitions/CustomDictionaryPath

description: Path to custom dictionary text file.

description: Replacement pairs.

$ref: #/definitions/CustomDictionaryScope

type: array

description: Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`.

description: Use Compounds.

required: addWords name path

description: Inline Dictionary Definitions

description: Optional description.

description:
List of words to always be considered incorrect. Words found in `flagWords` override `words`.

Format of `flagWords`
- single word entry - `word`
- with suggestions - `word:suggestion` or `word->suggestion, suggestions`

Example: ```ts "flagWords": [   "color: colour",   "incase: in case, encase",   "canot->cannot",   "cancelled->canceled" ] ```

description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.

description: Replacement pairs.

description:
A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.

Format of `suggestWords`
- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`
- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`

description: Use Compounds.

description: List of words to be considered correct.

required: flagWords name

description: Optional description.

description: Replacement pairs.

description: Use Compounds.

description: List of words to be considered correct.

description: Optional description.

description: Replacement pairs.

description: Use Compounds.

description: List of words to be considered correct.

description: Optional description.

description: Path to the file.

description: Replacement pairs.

description: Use Compounds.

description:
Use by dictionary authors to help improve the quality of suggestions given from the dictionary.

Added with `v5.16.0`.

description:
The accent characters.

Default: `"\u0300-\u0341"`

description: A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.

description: The alphabet to use.

description: Define edit costs.

description: Used by dictionary authors

description:
An optional set of characters that can possibly be removed from a word before checking it.

This is useful in languages like Arabic where Harakat accents are optional.

Note: All matching characters are removed or none. Partial removal is not supported.

description: The locale of the dictionary. Example: `nl,nl-be`

description: Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.

description:
This a negative reference to a named dictionary.

It is used to exclude or include a dictionary by name.

The reference starts with 1 or more `!`.
- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.
- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.

description: This a reference to a named dictionary. It is expected to match the name of a dictionary.

description:
Reference to a dictionary by name. One of:
-  {@link  DictionaryRef }
-  {@link  DictionaryNegRef }

description: The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.

description: This is the base cost for making an edit.

description: The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.

description: The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.

description: This is the cost for characters not in the alphabet.

description:
A File System Path.

Special Properties:
- `${cwd}` prefix - will be replaced with the current working directory.
- Relative paths are relative to the configuration file.

description: Features are behaviors or settings that can be explicitly configured.

description: Enable/disable using weighted suggestions.

description: A File System Path. Relative paths are relative to the configuration file.

description: These are glob expressions.

description:
Selected Hunspell AFF content. The content must be UTF-8

Sections:
- TRY
- MAP
- REP
- KEY
- ICONV
- OCONV

Example: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(Ĳ) ```

description: The costs to apply when using the hunspell settings

description:
The cost to convert between convert pairs.

The value should be slightly higher than the mapCost.

description:
The cost of replacing or swapping any adjacent keyboard characters.

This should be slightly cheaper than `tryCharCost`.

description:
mapSet replacement cost is the cost to substitute one character with another from the same set.

Map characters are considered very similar to each other and are often the cause of simple mistakes.

description: The cost to substitute pairs found in the replace settings.

description: The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`

description: This can be 'typescript,cpp,json,literal haskell', etc.

description: This can be '*', 'typescript', 'cpp', 'json', etc.

description: True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.

description:
Determines if words must match case and accent rules.

- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.
- `true` - Case and accents are enforced.

description: Optional description of configuration.

description:
Optional list of dictionaries to use. Each entry should match the name of the dictionary.

To remove a dictionary from the list, add `!` before the name.

For example, `!typescript` will turn off the dictionary with the name `typescript`.

See the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.

description:
Define additional available dictionaries.

For example, you can use the following to add a custom dictionary:

```json "dictionaryDefinitions": [   { "name": "custom-words", "path": "./custom-words.txt"} ], "dictionaries": ["custom-words"] ```

description: Is the spell checker enabled.

description: Optional identifier.

description:
List of regular expression patterns or pattern names to exclude from spell checking.

Example: `["href"]` - to exclude html href pattern.

Regular expressions use JavaScript regular expression syntax.

Example: to ignore ALL-CAPS words

JSON ```json "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] ```

YAML ```yaml ignoreRegExpList:   - >-    /\b[A-Z]+\b/g ```

By default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.

While you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).

description:
List of regular expression patterns or defined pattern names to match for spell checking.

If this property is defined, only text matching the included patterns will be checked.

While you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).

description: The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages.

description: Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.

description: Optional name of configuration.

description:
Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.

description:
Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.

For example:

```javascript "ignoreRegExpList": ["comments"], "patterns": [   {     "name": "comment-single-line",     "pattern": "/#.*/g"   },   {     "name": "comment-multi-line",     "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"   },   // You can also combine multiple named patterns into one single named pattern   {     "name": "comments",     "pattern": ["comment-single-line", "comment-multi-line"]   } ] ```

description: List of words to be considered correct.

description: This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.

description: Optional description of configuration.

markdownDescription:
Enable / Disable checking file types (languageIds).
These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
To disable a language, prefix with `!` as in `!json`,

Example:
```
jsonc       // enable checking for jsonc
!json       // disable checking for json
kotlin      // enable checking for kotlin
```

title: File Types to Check

description: Is the spell checker enabled.

description: languageIds for the files to spell check.

description: Glob pattern or patterns to match against.

description: Optional identifier.

description: Sets the locale.

description: Sets the programming language id to match file type.

description:
Additional settings for individual languages.

See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.

description: By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.

description: The maximum number of times the same word can be flagged as an error in a file.

description: The maximum number of problems to report in a file.

description: The minimum length of a word before checking it against a dictionary.

description: Optional name of configuration.

description: Number of suggestions to make.

description: The PnP files to search for. Note: `.mjs` files are not currently supported.

description:
The maximum number of changes allowed on a word to be considered a suggestions.

For example, appending an `s` onto `example` -> `examples` is considered 1 change.

Range: between 1 and 5.

description: The maximum amount of time in milliseconds to generate suggestions for a word.

description:
Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.

When true, the spell checker will search up the directory structure for the existence of a PnP file and load it.

description: List of words to be considered correct.

description: Id of the Adjustment, i.e. `short-compound`

description: The amount of penalty to apply.

description: RegExp pattern to match

description: This matches the name in a pattern definition.

description: A PatternRef is a Pattern or PatternId.

enum: Base64 Base64MultiLine Base64SingleLine CStyleComment CStyleHexValue CSSHexValue CommitHash CommitHashLink Email EscapeCharacters HexValues href PhpHereDoc PublicKey RsaCert SshRsa SHA HashStrings SpellCheckerDisable SpellCheckerDisableBlock SpellCheckerDisableLine SpellCheckerDisableNext SpellCheckerIgnoreInDocSetting string UnicodeRef Urls UUID Everything

description: Description of the pattern.

description: Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.

description: RegExp pattern or array of RegExp patterns.

description: A list of pattern names or regular expressions.

description: The module or path to the the reporter to load.

description: Options to send to the reporter. These are defined by the reporter.

title: name

title: name

title: options

description:
Declare a reporter to use.

`default` - is a special name for the default cli reporter.

Examples:
- `"default"` - to use the default reporter
- `"@cspell/cspell-json-reporter"` - use the cspell JSON reporter.
- `["@cspell/cspell-json-reporter", { "outFile": "out.json" }]`

description: Simple Glob string, the root will be globRoot.

description:
A WeightedMapDef enables setting weights for edits between related characters and substrings.

Multiple groups can be defined using a `|`. A multi-character substring is defined using `()`.

For example, in some languages, some letters sound alike.

```yaml   map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.   replace: 50    # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```

The following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml   map: 'aeiouy'   insDel: 50     # Make it is cheaper to insert or delete a vowel.   replace: 45    # It is even cheaper to replace one with another. ```

Note: the default edit distance is 100.

description: Configuration File Version.

description: Legacy Configuration File Versions.

description: Url to JSON Schema

description: Define cache settings.

description: Optional description of configuration.

title: File Types to Check

description:
Enable scanning files and directories beginning with `.` (period).

By default, CSpell does not scan `hidden` files.

description: Is the spell checker enabled.

description: Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)

description: Configure CSpell features.

description:
Glob patterns of files to be checked.

Glob patterns are relative to the `globRoot` of the configuration file that defines them.

description: Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.

description:
The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.

Use `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.

Special Values:
- `${cwd}` - will be replaced with the current working directory.
- `.` - will be the location of the containing configuration file.

description: Optional identifier.

description:
Glob patterns of files to be ignored.

Glob patterns are relative to the `globRoot` of the configuration file that defines them.

description:
Allows this configuration to inherit configuration for one or more other files.

See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.

description:
Current active spelling language. This specifies the language locale to use in choosing the general dictionary.

For example:

- "en-GB" for British English.
- "en,nl" to enable both English and Dutch.

description: Forces the spell checker to assume a give language id. Used mainly as an Override.

description: Optional name of configuration.

description: Prevents searching for local configuration when checking individual documents.

description: Number of suggestions to make.

description:
Overrides are used to apply settings for specific files in your project.

For example:

```javascript "overrides": [   // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:   {     "filename": "**/{*.hrr,*.crr}",     "languageId": "cpp"   },   // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):   {     "language": "nl",     "filename": "**/dutch/**/*.txt"   } ] ```

description: Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.

description:
Define which reports to use. `default` - is a special name for the default cli reporter.

Examples:
- `["default"]` - to use the default reporter
- `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter.
- `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]`
- `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter.

description: Show status.

description: Delay in ms after a document has changed before checking it for spelling errors.

description: Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.

description: Words to add to global dictionary -- should only be in the user config file.

description: Verify that the in-document directives are correct.

description:
Configuration format version of the settings file.

This controls how the settings in the configuration file behave.

description: List of words to be considered correct.


trivia.schema.json

title: Red-DiscordBot Trivia List file

format: uri

description: Author of the Trivia list.

description: The configuration for a trivia session.

description: Whether or not the bot gains points during the session.

description: The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.

type: integer

description: Number of points required in order to win the trivia, must be a positive integer.

description: The payout multiplier, must be a positive number or zero.

description: Whether or not to reveal the answer when the question times out.

description: Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.

description: Whether to hide the answers in spoilers when revealing the question's answers.


djlint.json

profile: html

description: JSON schema fcor djLint's configuration file

$ref: #/definitions/css-beautify

$ref: #/definitions/js-beautify

examples: {filename}:{line}: {code} {message} {match}

enum: html django jinja nunjucks handlebars golang angular

title: djlint schema


drupal-migration.json

title: The migration ID (machine name)

title: The human-readable label for the migration

title: Whether the migration is auditable

title: List of tags, used by the plugin manager for filtering

title: Deriver class

title: The source plugin configuration

title: Source plugin ID

title: The configuration describing the process plugins

title: The destination plugin configuration

title: Destination plugin ID

title: Migrations to run before this migration

title: List of migration IDs that must be run before this migration

title: List of migration IDs that, if they exist, must be run before

title: The migration's dependencies

title: List of plugin providers

title: Class for migration implementation

title: JSON schema for Drupal migration files


host.json

description: Configuration settings for the function result aggregator.

description: The maximum batch size for aggregations. If this value is reached before the 'flushTimeout', all values will be flushed.

description: The aggregation duration. The aggregator will flush periodically based on this value.

description: The list of functions the host should load.

description: Value indicating the timeout duration for all functions.

description: Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions

description: Configuration settings for Singleton lock behavior.

description: The period that function level locks are taken for (they will auto renew).

description: The period that listener locks are taken for.

description: The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.

description: The maximum amount of time the runtime will try to acquire a lock.

description: The interval between lock acquisition attempts.

description: Configuration settings for the Functions host health monitor

description: Specifies whether the feature is enabled.

description: The time interval between the periodic background health checks

description: A sliding time window used in conjunction with the healthCheckThreshold setting.

description: Maximum number of times the health check can fail before a host recycle is initiated.

description: The threshold at which a performance counter will be considered unhealthy.

description: Configuration settings for 'http' triggers.

description: Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.

default: api

description: Defines the the maximum number of http functions that will execute in parallel.

description: Defines the maximum number of outstanding requests that will be held at any given time.

description: Indicates whether dynamic host counter checks should be enabled.

description: Configuration settings for Strict-Transport-Security

description: Indicates whether the hsts configuration should be applied

description: Defines the list of host names that will not add the HSTS header.

description: Indicates whether the includeSubDomain parameter of the Strict-Transport-Security header should be enabled.

description: Defines the max-age parameter of the Strict-Transport-Security header.

description: Indicates whether the preload parameter of the Strict-Transport-Security header should be enabled.

description: Allows you to set custom headers in the HTTP response, ex. X-Content-Type-Options.

description: Configuration settings for 'queue' triggers.

description: The maximum interval in milliseconds between queue polls.

description: The number of queue messages to retrieve and process in parallel (per job function).

description: The number of times to try processing a message before moving it to the poison queue

description: The threshold at which a new batch of messages will be fetched. The default is batchSize/2.

description: The visibility timeout that will be applied to messages that fail processing.

description: The maximum interval between queue polls. Minimum is 00:00:00.100 (100 ms).

description: The time interval between retries when processing of a message fails.

description: The number of queue messages that the Functions runtime retrieves simultaneously and processes in parallel. When the number being processed gets down to the `newBatchThreshold`, the runtime gets another batch and starts processing those messages. So the maximum number of concurrent messages being processed per function is `batchSize` plus `newBatchThreshold`. This limit applies separately to each queue-triggered function.

description: This setting is only available in extension version 5.0.0 and higher. It represents the encoding format for messages.

description: Configuration settings for 'orchestration'/'activity' triggers.

description: Alternate task hub names can be used to isolate multiple Durable Functions applications from each other, even if they're using the same storage backend.

default: DurableFunctionsHub

description: The number of messages to pull from the control queue at a time.

description: The number of control queue messages that can be buffered in memory at a time, at which point the dispatcher will wait before dequeuing any additional messages.

description: The visibility timeout of dequeued control queue messages.

description: The maximum control and work-item queue polling interval in the hh:mm:ss format. Higher values can result in higher message processing latencies. Lower values can result in higher storage costs because of increased storage transactions.

description: The partition count for the control queue. May be a positive integer between 1 and 16.

description: The name of a connection string to use for the History and Instances tables. If not specified, the azureStorageConnectionStringName connection is used.

description: The prefix to use for the History and Instances tables when trackingStoreConnectionStringName is specified. If not set, the default prefix value will be DurableTask. If trackingStoreConnectionStringName is not specified, then the History and Instances tables will use the hubName value as their prefix, and any setting for trackingStoreNamePrefix will be ignored.

description: When set to false, uses a partition management algorithm that reduces the possibility of duplicate function execution when scaling out.

description: The visibility timeout of dequeued work item queue messages.

description: A value indicating whether to trace the inputs and outputs of function calls. The default behavior when tracing function execution events is to include the number of bytes in the serialized inputs and outputs for function calls. This behavior provides minimal information about what the inputs and outputs look like without bloating the logs or inadvertently exposing sensitive information. Setting this property to true causes the default function logging to log the entire contents of function inputs and outputs.

description: A value indicating whether to write orchestration replay events to Application Insights.

description: The URL of an Azure Event Grid custom topic endpoint. When this property is set, orchestration life-cycle notification events are published to this endpoint. This property supports App Settings resolution.

description: The name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at EventGridTopicEndpoint.

description: The number of times to retry if publishing to the Event Grid Topic fails.

description: The Event Grid publishes retry interval in the hh:mm:ss format.

description: A list of event types to publish to Event Grid. If not specified, all event types will be published.

enum: Started Pending Completed Failed Terminated

description: The maximum number of activity functions that can be processed concurrently on a single host instance.

description: The maximum number of orchestrator functions that can be processed concurrently on a single host instance.

description: When set to true, apps will require acquiring an app-level blob lease before processing task hub messages.

description: Enable gracefully shutting down to reduce the chance of host shutdowns failing in-process function executions.

description: The maximum number of entity operations that are processed as a batch. If set to 1, batching is disabled, and each operation message is processed by a separate function invocation.

description: Configuration settings for Azure Cosmos DB bindings and triggers.

description: ConnectionMode to be used on the DocumentClients.

enum: Gateway Direct

default: Gateway

description: Protocol to be used on the DocumentClients.

enum: Https Tcp

default: Https

description: Lease prefix to use across all functions in an app.

$ref: #/definitions/aggregator

description: Configuration settings for Application Insights logging.

description: Configuration settings for Application Insights client-side adaptive sampling.

description: If true, client-side adaptive sampling is enabled.

description: The target rate that the adaptive algorithm aims for on each instance

$ref: #/definitions/functions

$ref: #/definitions/functionTimeout

$ref: #/definitions/healthMonitor

description: The unique ID for this job host. Can be a lower case GUID with dashes removed

description: Configuration settings for logging.

description: The default level for logging. If a category level is not specified, this value is used.

enum: Critical Debug Error Information None Trace Warning

default: Information

description: Log levels for specific categories.

$ref: #/definitions/singleton

$ref: #/definitions/watchDirectories

description: Configuration settings for logging/tracing behavior.

description: The tracing level used for console logging.

enum: off error warning info verbose

description: Value determining what level of file logging is enabled.

description: Configuration settings for 'serviceBus' triggers.

description: The maximum number of concurrent calls to the callback the message pump should initiate.

description: The default PrefetchCount that will be used by the underlying MessageReceiver.

description: The maximum duration within which the Service Bus message lock will be renewed automatically.

description: Specifies whether messages should be automatically completed after successful processing.

description: Configuration settings for 'eventHub' triggers.

description: The maximum event count received per receive loop.

description: The default PrefetchCount that will be used by the underlying EventProcessorHost.

description: The number of batches to process before creating an EventHub cursor checkpoint

description: Configuration settings for extension bundle

description: The id of the extension bundle

description: The version of the extension bundle.

description: Configuration settings for Language Workers.

description: Specifies full path of the directory for language workers

description: Configuration settings for logging.

description: Log levels for specific categories.

description: The interval at which the current rate of telemetry is reevaluated.

description: The initial sampling percentage applied at the start of the sampling process to dynamically vary the percentage.

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to raise sampling percentage again to capture more data.

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to lower sampling percentage again to capture less data.

description: As sampling percentage varies, this property determines the minimum allowed sampling percentage.

description: As sampling percentage varies, this property determines the maximum allowed sampling percentage.

description: In the calculation of the moving average, the weight assigned to the most recent value. Use a value equal to or less than 1. Smaller values make the algorithm less reactive to sudden changes.

description: A semi-colon delimited list of types excluded from sampling. Recognized: Dependency, Event, Exception, PageView, Request, Trace.

description: A semi-colon delimited list of types that you want to be sampled. Recognized: Dependency, Event, Exception, PageView, Request, and Trace.

description: Enables live metrics collection.

description: Enables live metrics filters.

description: Enables dependency tracking

description: Enables Kudu performance counters collection.

description: Enables or disables extended HTTP request information for HTTP triggers.

description: Enables or disables support of W3C distributed tracing protocol (and turns on legacy correlation schema). Enabled by default if enableHttpTriggerExtendedInfoCollection is true. If enableHttpTriggerExtendedInfoCollection is false, this flag applies to outgoing requests only, not incoming requests

description: Enables or disables injection of multi-component correlation headers into responses. Enabling injection allows Application Insights to construct an Application Map to when several instrumentation keys are used.

description: The endpoint used to connect to the Application Insights Snapshot Debugger service.

description: The weight given to the current process memory size when checking if there's enough memory to take a snapshot.

description: The limit on the number of failed requests to request snapshots before the telemetry processor is disabled.

description: Enables or disables tracking of exceptions that aren't tracked by Application Insights telemetry.

description: Enables or disables snapshot collection.

description: Enables or disables snapshot collection is enabled in developer mode.

description: Enables or disables snapshot creation even if the Application Insights Profiler is collecting a detailed profiling session.

description: Enables or disables filtering of exceptions.

description: Determines whether to run the SnapshotUploader process at below normal priority.

description: The maximum number of problems that we can track at any time.

description: The maximum number of snapshots collected for a single problem.

description: How often to reset the problem counters in a range from one minute to seven days.

description: Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger

description: How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day.

description: Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP.

description: If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple.

description: Determines whether or not to process snapshots in a low IO priority thread.

description: The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side.

description: The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application.

description: Specifies the folder to write minidumps and uploader log files. If not set, then %TEMP%\Dumps is used.

description: How many times Application Insights needs to see an exception before it asks for snapshots.

description: Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings.

description: Managed dependency is a feature that is currently only supported with PowerShell based functions. It enables dependencies to be automatically managed by the service.

description: If true, the requirements.psd1 file is processed

description: Retry policy of function execution failures at the app level. Retry policy applies to all the functions in the function app.

description: Retry strategy to use for retrying function executions

description: The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

description: Value indicating the delayInterval for function execution retries when using FixedDelay strategy.

description: Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.

description: Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.

description: Configuration settings for Custom Handler.

description: Configuration settings for Custom Handler process

description: Name or path to the Custom Handler process

description: WorkingDirectory to be used by the Custom Handler process. If not set, defaults to function app root folder.

description: Arguments to be passed to the Custom Handler process. Can use environment variables following pattern %envVarName%

description: Forward HttpTrigger request to the custom handler

description: An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions

description: The version of the Azure Functions host.json schema. This is NOT the version of the Azure Functions host.

description: The sender's email address across all functions.

description: The options that will be used for the message handler registered with the MessageReceiver.

description: Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion.

description: The maximum number of sessions that can be handled concurrently per scaled instance.

description: The maximum number of messages sent to the function when triggered.

description: A time span value expressed in hh:mm:ss.

description: Whether the trigger should automatically call complete after processing, or if the function code will manually call complete.

description: The target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from maxEventBatchSize.

description: The maximum number of events that will be included in a batch for a single invocation.

description: The number of batches to process before creating a checkpoint for the Event Hub.

description: The number of events that will be eagerly requested from Event Hubs and held in a local cache to allow reads to avoid waiting on a network operation.

description: The protocol and transport that is used for communicating with Event Hubs.

description: The proxy to use for communicating with Event Hubs over web sockets. A proxy cannot be used with the amqpTcp transport.

description: The address to use when establishing a connection to Event Hubs, allowing network requests to be routed through an application gateway or other path needed for the host environment.

description: The location in the event stream to start processing when a checkpoint does not exist in storage. Applies to all partitions.

description: Specifies the enqueued time of the event in the stream from which to start processing. When initialOffsetOptions/type is configured as fromEnqueuedTime, this setting is mandatory. Supports time in any format supported by DateTime.Parse(), such as 2020-10-26T20:31Z.

description: The approach to use for calculating retry delays. Exponential mode will retry attempts with a delay based on a back-off strategy where each attempt will increase the duration that it waits before retrying.

description: The maximum duration to wait for an Event Hubs operation to complete, per attempt.

description: The maximum delay to allow between retry attempts.

description: The maximum number of retry attempts before considering the associated operation to have failed.

description: The number of batches to process before creating an EventHub cursor checkpoint.

description: Configuration on processing event hub events.

description: The location in the event stream from which to start processing when a checkpoint doesn't exist in storage.

description: The default prefetch that will be used by the underlying EventProcessorHost.

description: The number of event batches to process before creating an EventHub cursor checkpoint.

description: The number of concurrent invocations allowed for each blob-triggered function.

description: The number of times to try processing a message before moving it to the poison queue.

description: Configuration settings for dynamic concurrency

description: Enables or disables dynamic concurrency for function apps.

description: Enables or disables the learned concurrency values persisting in storage.

title: JSON schema for Azure Functions host.json files


size-limit.json

title: Configuration Section

title: relative path to files

title: relative paths to files

title: Path or Glob Pattern

title: partial import to test tree-shaking

title: size or time limit for files from the path option. It should be a string with a number and unit, separated by a space.

title: the name of the current section. It will only be useful if you have multiple sections.

title: when using a custom webpack config, a webpack entry could be given. It could be a string or an array of strings. By default, the total size of all entry points will be checked.

title: with false it will disable webpack.

title: with false it will disable calculating running time.

title: with false it will disable gzip compression.

title: with true it will use brotli compression and disable gzip compression.

title: an array of files and dependencies to exclude from the project size calculation.

title: a path to a custom webpack config.

title: JSON Schema for configuration for size-limit


$comment: JSON Schema for CRYENGINE 5.4

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

required: name value

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

description: Arguments that has to be passed to the command. Leave empty if it has not parameters

required: content info require version

title: CryProj schema


ts-force-config.json

description:
If using `sfdx-cli` auth, this is the only property needed to authenticate.
Otherwise, supply additional oAuth parameters

description: The Target SObject API name

description: The generated class property name

required: apiName propName

description: Object used to configure advanced settings on SObject generation

description: The Target SObject API name

description: Defaulted to true.  If set to false, names will NOT be auto-converted to standard javascript conventions

description:
The generated class name.  If not set, it will be automatically
converted to standard javascript Class convention

description:
*Overrides Global Setting*
The path to generate files to.
   If the destination is a folder, it will generate one file per object.
   If the destination is a `.ts` file, a single file will be generated.
   If not set, class output will be logged to `stdout`

description: List of field mappings to override the auto-conversion

$ref: #/definitions/FieldMapping

description:
*Overrides Global Setting*
Make picklist fields strongly typed to generated enums. `generatePicklists` must also be `true`
  `ALL`: for all picklist fields, regardless of salesforce enforcement
  `RESTRICTED`: only on fields where the values are restricted on Salesforce

$ref: #/definitions/AuthConfig

description:
Authentication Method.  Choose one of three:
- You can either username/password oAuth configuration
- sfdx configuration (`username` only)
- `accessToken` & `instanceUrl`
See readme for examples.

description: Flag to generate enums for picklist fields.  Defaulted to false

description: The SObjects to generate classes for.  Can either be a string or an `SObjectConfig` object

$ref: #/definitions/SObjectConfig


ntangle.json

title: NTangle - https://github.com/Avanade/ntangle

title: The 'Root' object (database-driven)

description: The 'RootConfig' object defines the global properties that are used to drive the underlying database-driven CDC-oriented code-generation.

title: The default 'Schema' name where the existing tables are defined within the database.

description: This is used as the default 'Schema' for all child objects. Defaults to 'dbo' (literal).

title: The schema name for the _ntangle_ generated 'CDC'-related database artefacts.

description: Defaults to 'NTangle' (literal).

title: Indicates whether to create the 'CdcSchema' within the database.

description: Defaults to 'false'.

title: The table name for the 'Cdc'-VersionTracking.

description: Defaults to 'VersionTracking' (literal).

title: Indicates whether to enable 'Cdc' within the database for the tables that participate.

description: Defaults to 'false'. This option can be overridden for each underlying table referenced.

title: Indicates whether to include the generation of the generic 'CDC'-IdentifierMapping database capabilities.

description: Where set to 'true' each underlying 'Table' and corresponding 'Join' must set 'IdentifierMapping' explicitly.

title: The type for the identifier mapping value.

description: Defaults to 'String'.

enum: String Int Long Guid

title: The table name for the 'Cdc'-IdentifierMapping.

description: Defaults to 'IdentifierMapping' (literal).

title: The stored procedure name for the 'Cdc'-IdentifierMapping create.

description: Defaults to 'spIdentifierMappingCreate' (literal).

title: The column name for the 'IsDeleted' (logical delete) capability (if any).

description: Defaults to 'IsDeleted'.

title: The option to automatically rename the SQL Tables and Columns for use in .NET.

description: Defaults to 'SnakeKebabToPascalCase' which will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.

enum: None PascalCase SnakeKebabToPascalCase

title: The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)

title: The JSON Serializer to use for JSON property attribution.

description: Defaults to 'SystemText'.

enum: SystemText Newtonsoft

title: The type of service that manages the underlying orchestrator.

description: Defaults to 'None'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.

enum: None HostedService Service

title: The root for the event name by prepending to all event subject names via CDC.

title: The default formatting for the Subject when an Event is published via CDC.

description: Defaults to 'NameOnly'.

enum: NameOnly NameAndKey NameAndTableKey

title: The formatting for the Action when an Event is published via CDC.

description: Defaults to 'None' (no formatting required, i.e. as-is).

title: The URI kind for the event source URIs for CDC.

description: Defaults to 'Relative' (being a relative path).

enum: None Absolute Relative RelativeOrAbsolute

title: The URI root for the event source by prepending to all event source URIs for CDC.

description: The event source is only updated where an 'EventSourceKind' is not 'None'.

title: The default formatting for the Source when an Event is published via CDC.

description: Defaults to 'NameAndTableKey' (being the child 'Cdc.ModelName' appended with the corresponding table key).

title: The root for the event type by prepending to all event type names via CDC.

description: Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc. Defaults to 'EventSubjectRoot'.

title: Indicates whether to generate the event outbox SQL and .NET artefacts.

description: Defaults to 'false'.

title: The schema name of the event outbox table.

description: Defaults to 'Outbox' (literal).

title: Indicates whether to create the 'OutboxSchema' within the database.

description: Defaults to 'false'.

title: The name of the event outbox table.

description: Defaults to 'EventOutbox' (literal).

title: The stored procedure name for the event outbox enqueue.

description: Defaults to 'spEventOutboxEnqueue' (literal).

title: The stored procedure name for the event outbox dequeue.

description: Defaults to 'spEventOutboxDequeue' (literal).

title: The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.

description: Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'.

title: The path (directory) for the Schema Database-related artefacts.

description: Defaults to 'PathBase' + '.Database' (literal). For example 'Avanade.Application.Database'.

description: Defaults to 'PathDatabase' + '/Schema' (literal). For example 'Avanade.Application.Database/Schema'.

description: Defaults to 'PathDatabase' + '/Migrations' (literal). For example 'Avanade.Application.Database/Migrations'.

title: The path (directory) for the CDC-related (.NET) artefacts.

description: Defaults to 'PathBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.

title: The base Namespace (root) for the .NET artefacts.

title: The Namespace (root) for the CDC-related Publisher .NET artefacts.

description: Defaults to 'NamespaceBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.

title: The Namespace (root) for the Outbox-related Publisher .NET artefacts.

description: Defaults to 'NamespacePublisher'.

title: The corresponding 'Table' collection.

description: A 'Table' object provides the primary database table configuration for Change Data Capture (CDC), including multiple child table joins to form a composite entity.

$ref: #/definitions/Table

title: 'Table' object (database-driven)

description: The 'Table' object enables the definition of the primary table, one-or-more child tables and their respective join relationships, to enable Change Data Capture (CDC) event publishing. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.

title: The name of the primary table.

title: The default schema name used where not otherwise explicitly specified.

description: Defaults to 'Root.Schema'.

title: The name of the primary table.

description: Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).

title: The table alias name (must be unique).

description: Will automatically default where not specified; for example a table named 'Person' will default to 'p'.

title: The list of 'Column' names to be included in the underlying generated output.

description: Where not specified this indicates that all 'Columns' are to be included.

title: The list of 'Column' names to be excluded from the underlying generated output.

description: Where not specified this indicates no 'Columns' are to be excluded.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'.

title: The 'CDC' _execute_ batch stored procedure name.

description: Defaults to 'sp' (literal) + 'Name' + 'BatchExecute' (literal); e.g. 'spNameBatchExecute'.

title: The 'CDC' _complete_ batch stored procedure name.

description: Defaults to 'sp' (literal) + 'Name' + 'BatchComplete' (literal); e.g. 'spNameBatchComplete'.

title: The schema name for the generated 'CDC'-related database artefacts.

description: Defaults to 'Root.CdcSchema'.

title: The corresponding 'CDC' Batch tracking table name.

description: Defaults to 'Name' + 'BatchTracking' (literal).

title: The .NET model name.

description: Defaults to 'Name'.

title: The list of additional (non-default) Dependency Injection (DI) parameters for the generated CDC 'Orchestrator' constructor.

description: Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred.

title: The .NET database 'IDatabase' Type name used in the constructor for Dependency Injection (DI).

description: Defaults to 'IDatabase'.

title: The list of 'Column' names that should be included (in addition to the primary key) for a logical delete.

description: Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.

description: Defaults to 'Root.Service'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.

title: The list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking).

description: Defaults to 'Root.CdcExcludeColumnsFromETag'.

title: The list of 'Column' names that represent the tenant identifier.

title: The partition key.

description: A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.

title: The list of 'Column' names that represent the partition key.

title: The Event Source.

description: Defaults to 'Schema' + '/' (literal) + 'Name' (as lowercase). Note: when used in code-generation the 'Root.EventSourceRoot' will be prepended where specified.

title: The default formatting for the Source when an Event is published.

description: Defaults to 'Root.EventSourceFormat'.

title: The Event Subject.

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventSubjectRoot' will be prepended where specified.

title: The default formatting for the Subject when an Event is published.

description: Defaults to 'Root.EventSubjectFormat'.

title: The Event Type.

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventTypeRoot' will be prepended where specified.

title: Indicates whether to perform Identifier Mapping (mapping to 'GlobalId') for the primary key.

description: This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).

title: The JSON name for the 'GlobalId' property where 'IdentifierMapping' is 'true'. Defaults to 'globalId'.

description: Defaults to 'Root.ColumnIsDeleted'.

title: The corresponding 'Join' collection.

description: A 'Join' object provides the configuration for a table join.

$ref: #/definitions/Join

title: The corresponding 'Where' collection.

description: A 'Where' object provides the configuration for a table where clause.

$ref: #/definitions/Where

title: The corresponding 'TableMapping' collection.

$ref: #/definitions/TableMapping

title: 'Join' object (database-driven)

description: The 'Join' object defines a join to another (or same) table within the logical CDC entity.  The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.

title: The unique name.

description: A unique name is required where the same 'Table' is referenced more than once within a logical CDC entity. However, generally, this will represent the unique name of the table within the database.

title: The schema name of the table to join.

description: Defaults to 'Cdc.Schema'; i.e. same schema.

title: The name of the table to join.

title: The 'Schema' and 'Table' alias name.

description: Will automatically default where not specified.

title: The SQL join type.

description: Defaults to 'Cdc'. The 'Cdc' value indicates this is a related secondary table (within a logical CDC entity) that also has Change Data Capture turned on and equally needs to be monitored for changes.

enum: Cdc Inner Left Right Full

title: The name of the table to join to (must be previously specified).

description: Defaults to parent 'Table.Name'.

title: The join cardinality being whether there is a One-to-Many or One-to-One relationship.

description: Defaults to 'OneToMany'. This represents the Parent ('JoinTo') to child (_this_) relationship.

title: The query size multiplier for the CDC-Join.

description: Defaults to '1.0'. This is applied to the execute stored procedure '@MaxQuerySize' parameter to allow tailoring on the join query ('TOP') sizes to optimize selection. Must be greater than zero and less than or equal to 100.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.

title: The .NET model name.

description: Defaults to 'Name'.

title: The .NET property name.

description: Defaults to 'Model' where 'JoinCardinality' is 'OneToOne'; otherwise, it will be the 'Model' pluralized.

description: Defaults to 'CodeGeneration.CdcExcludeColumnsFromETag'.

title: The corresponding 'JoinOn' collection.

title: The corresponding 'JoinMapping' collection.

title: 'JoinOn' object (database-driven)

description: The 'JoinOn' object defines the join on characteristics for a 'Join' object.

title: The name of the join column (from the 'Join' table).

title: The name of the join to column.

description: Defaults to 'Name'; i.e. assumes same name.

title: The SQL statement for the join on bypassing the corresponding 'ToColumn' specification.

title: 'JoinMapping' object (database-driven)

description: The 'JoinMapping' object defines one or more related table identifier mappings.

title: The name of of the existing column that requires identifier mapping.

title: The schema name of the related table.

description: Defaults to the owning (parent) table schema.

title: The name of the related table.

title: 'Where' object (database-driven)

description: This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.

title: The column name.

description: The column name.

title: The where nullability clause operator

description: This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .

title: The where clause equality operator

description: Defaults to 'EQ' where 'Value' is specified.

title: The comparison value

description: This must be valid formatted/escaped SQL.

title: 'TableMapping' object (database-driven)

description: The 'TableMapping' object defines one or more related table identifier mappings.

title: The schema name of the related table.

title: The name of the related table.


mycode.json

enum: MyCode LibraryCode UnrelatedCode

description: Script that is executed by passing a string to the host-provided eval function.

default: MyCode

$ref: #/definitions/classification

description: Script that is executed by passing a string to the 'Function' constructor.

default: LibraryCode

description: Script that is executed by passing a string to the 'setTimeout', 'setImmediate', or 'setInterval' functions.

default: UnrelatedCode

description: An array of urls or files that are classified as 'MyCode'.

$ref: #/definitions/includes

description: An array of urls or files that are classified as 'LibraryCode'.

description: An array of urls or files that are classified as 'UnrelatedCode'.

title: JSON schema for mycode.js files


nlu.schema.json

title: JSON schema for NLU (npm-link-up) library.

$ref: #/definitions/PackagesMap


mimetypes.json

description: A file extension

title: Mime types


ort-configuration-schema.json

title: ORT configuration

description: The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.

$ref: #/definitions/LicenseFilePatterns

$ref: #/definitions/Severity

$ref: #/definitions/Analyzer

$ref: #/definitions/Advisor

$ref: #/definitions/Downloader

$ref: #/definitions/Scanner

$ref: #/definitions/Reporter

$ref: #/definitions/Notifier

$ref: #/definitions/NexusIq

$ref: #/definitions/OssIndex

$ref: #/definitions/VulnerableCode

$ref: #/definitions/GitHubDefects

$ref: #/definitions/Osv

$ref: #/definitions/AdvisorOptions

$ref: #/definitions/SourceCodeOrigins

$ref: #/definitions/Mail

$ref: #/definitions/Jira

$ref: #/definitions/ReporterOptions

$ref: #/definitions/Archive

$ref: #/definitions/DetectedLicenseMapping

$ref: #/definitions/FileListStorage

$ref: #/definitions/ScannerOptions

$ref: #/definitions/Storages

$ref: #/definitions/StorageTypes

$ref: #/definitions/ProvenanceStorage

$ref: #/definitions/FileStorage

$ref: #/definitions/PostgresConfig


codeship-services.json

$ref: #/definitions/ExternalService

title: CodeShip Pro Service

description: The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it

description: If true, the docker socket will be exposed in this service.

description: How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.

$ref: #/definitions/externalBuild

description: Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.

description: The command to run when launching the service, overriding the 'CMD' in the image. Optional.

description: The branch to use for caching. Defaults to 'master'

description: The name of another defined service that provides the Docker configuration for building and running this service. Optional.

description: A specific Dockerfile to use, rather than the one in the build context

description: The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.

description: The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.

description: A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.

description: The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.

description: Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.

description: A pre-existing image to use for this service. Mutually exclusive with 'build'

description: A list of other services that this service depends on. Use this instead of 'links'

description: A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings

description: A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.

description: A list of other services which should have their defined volumes mounted into this service as well. Optional.

title: Image Build

description: Configuration of how to build the image for this service

description: DEPRECATED: Use 'context' instead.

description: DEPRECATED: Use 'dockerfile' instead

description: The output image name for this image. Optional.

description: The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file

description: A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.

$ref: #/definitions/externalBuildConfigure

description: Build args to pass to Docker. Optional.

description: One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.

description: A list of encrypted key/value pairs to be used as build args to Docker. Optional.

description: codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.

title: CodeShip Pro services configuration


description: The package unique identifier

description: The package version

description: The package meta-data locale

description: Optional Url type

description: Package moniker or tag

description: The distribution channel

title: Platform

description: The installer supported operating system

description: The installer minimum operating system version

enum: msix msi appx exe zip inno nullsoft wix burn pwa

description: Enumeration of supported installer types

enum: user machine

description: Scope indicates if the installer is per user or per machine

title: InstallModes

enum: interactive silent silentWithProgress

description: List of supported installer modes

description: Silent is the value that should be passed to the installer when user chooses a silent or quiet install

description: SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install

description: Interactive is the value that should be passed to the installer when user chooses an interactive install

description: InstallLocation is the value passed to the installer for custom install location. <INSTALLPATH> token can be included in the switch value so that winget will replace the token with user provided path

description: Log is the value passed to the installer for custom log file path. <LOGPATH> token can be included in the switch value so that winget will replace the token with user provided path

description: Upgrade is the value that should be passed to the installer when user chooses an upgrade

description: Custom switches will be passed directly to the installer by winget

description: List of additional non-zero installer success exit codes other than known default values by winget

enum: install uninstallPrevious

description: The upgrade method

description: List of commands or aliases to run the package

description: List of protocols the package provides a handler for

description: List of file extensions the package could support

description: List of Windows feature dependencies

description: List of Windows library dependencies

$ref: #/definitions/PackageIdentifier

$ref: #/definitions/PackageVersion

description: List of package dependencies from current source

description: List of external package dependencies

description: PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources

description: ProductCode could be used for correlation of packages across sources

description: List of appx or msix installer capabilities

description: List of appx or msix installer restricted capabilities

$ref: #/definitions/Locale

$ref: #/definitions/Platform

$ref: #/definitions/MinimumOSVersion

description: The installer target architecture

$ref: #/definitions/InstallerType

$ref: #/definitions/Scope

description: The installer Url

description: Sha256 is required. Sha256 of the installer

description: SignatureSha256 is recommended for appx or msix. It is the sha256 of signature file inside appx or msix. Could be used during streaming install if applicable

$ref: #/definitions/InstallModes

$ref: #/definitions/InstallerSwitches

$ref: #/definitions/InstallerSuccessCodes

$ref: #/definitions/UpgradeBehavior

$ref: #/definitions/Commands

$ref: #/definitions/Protocols

$ref: #/definitions/FileExtensions

$ref: #/definitions/Dependencies

$ref: #/definitions/PackageFamilyName

$ref: #/definitions/ProductCode

$ref: #/definitions/Capabilities

$ref: #/definitions/RestrictedCapabilities

description: A representation of a single-file manifest representing an app in the OWC. v1.0.0

description: The package meta-data locale

description: The publisher name

$ref: #/definitions/Url

description: The publisher home page

description: The publisher support page

description: The publisher privacy page or the package privacy page

description: The package author

description: The package name

description: The package home page

description: The package license

description: The license page

description: The package copyright

description: The package copyright page

description: The short package description

description: The full package description

$ref: #/definitions/Tag

description: The most common package term

description: List of additional package search terms

$ref: #/definitions/Channel

$ref: #/definitions/Installer

default: singleton

const: singleton

description: The manifest type

description: The manifest syntax version

required: PackageIdentifier PackageVersion PackageLocale Publisher PackageName License ShortDescription Installers ManifestType ManifestVersion


schema-app.json

title: JSON schema for Outblocks App configuration files

$ref: #/definitions/OutblocksApp

title: OutblocksApp

description: Name of the app. Defaults to directory name.

description: Type of the app.

enum: static function service

description: Environment variables common for all operations.

description: Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.

description: External URL of the app.

description: Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.

description: Application dependencies to inject.

$ref: #/definitions/Needs

description: Run config used for dev builds during run.

$ref: #/definitions/Run

description: CDN settings.

$ref: #/definitions/CDN

const: static

description: Routing type. Defaults to 'react'.

enum: react gatsby disabled

description: Remove trailing slash with permanent redirect. Currently used only for deployments. Defaults to 'true' when gatsby routing is used, 'false' otherwise.

description: Static application basic authentication config. Currently used only for deployments.

$ref: #/definitions/StaticBasicAuth

description: Static application build config used for deployment builds.

$ref: #/definitions/StaticBuild

description: Static deploy config.

$ref: #/definitions/StaticDeploy

const: service

description: Marks app as private - won't allow unauthenticated access.

description: Service application build config used for deployment builds.

$ref: #/definitions/ServiceBuild

description: Service application container config used for docker based deployments/runs.

$ref: #/definitions/ServiceContainer

description: Service deploy config.

$ref: #/definitions/ServiceDeploy

description: Service scheduler config.

$ref: #/definitions/Scheduler

const: function

description: The runtime in which the function is going to run, refer to cloud provider docs for possible options.

description: Name of the function that will be executed when the function is triggered. Not all deployment plugins support it. Defaults to application name.

description: Function application build config used for deployment builds.

$ref: #/definitions/FunctionBuild

description: Function deploy config.

$ref: #/definitions/FunctionDeploy

description: Function package config.

$ref: #/definitions/FunctionPackage

description: Function scheduler config.

title: Needs

title: Run config

description: Run plugin override. Defaults to first supported plugin available.

description: Command to be run to for dev mode.

description: Port override, by default just assigns next port starting from listen-port.

description: Additional environment variables available local run.

title: Static deploy config

description: Deploy plugin override. Defaults to first supported plugin available.

description: Minimum scale of container deployment (used if deployment uses a container).

description: Maximum scale of container deployment (used if deployment uses a container).

description: Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

description: File/dir patterns to exclude (or force include if starts with '!').

title: Service deploy config

description: Additional environment variables.

description: CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.

description: Memory limit in MiB of container deployment.

description: Minimum scale of container deployment.

description: Maximum scale of container deployment.

description: Service application container config used for docker based deployments.

title: Scheduler config

description: Scheduler cron, e.g. */30 * * * * runs every 30 minutes.

description: Name of cron (just for information purpose).

description: HTTP method to use. Defaults to 'GET'.

enum: GET POST HEAD PUT DELETE PATCH OPTIONS

description: Path to call in current app url.

description: Additional headers to use for this call.

title: Function deploy config

description: Additional environment variables.

description: Memory limit in MiB of function deployment.

title: Function package config

description: Package patterns to exclude (or force include if starts with '!').

title: CDN

title: Static app basic auth config

description: Basic auth realm name, defaults to 'restricted'.

description: Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).

title: Build static app

description: Additional environment variables available during build.

description: Command to be run to generate output files.

description: Output dir to where static files end up.

title: Service app build definition

description: Docker image to use. If specified, will try to pull this image if skip-build is enabled.

description: Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.

description: Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.

description: Docker build-args.

description: Docker context directory, relative to application dir.

description: Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.

title: Build function app

description: Output dir to where built files end up.

title: Service app container definition

description: Docker container port to use.

description: Docker command (CMD) to override.

description: Docker entrypoint (ENTRYPOINT) to override.


powerpages-web-template-manifest.json

type: functional

displayName: Card Template

description: renders the gallery card

displayName: Display name

description: Main heading of the web template

displayName: Items per row

description: No of items to be displayed per row

type: table

displayName: Select table

title: type

description: The web template type. Use 'functional' for custom site components and 'layout' for custom layouts.

enum: functional layout

description: The display name of the web template

description: The description of the web template

description: An array of table logical names that are used in the web template

title: params

description: The editable properties of the web template. These will be customizable in Studio

title: id

description: The id of the param. This correlates with the liquid tag's key for this property

examples: name count specifiedTable

description: The label displayed when editing a property in Studio. If no displayName is given, the label will fallback on the id

examples:
Display name
Items per row
Selected table

description: The description to be displayed in the tooltip when editing a property in Studio. If no description is given, no tooltip will be displayed

examples:
Main heading of the web template
No of items to be displayed per row

description: Used to specify a property that correlates to a table's logical name

description: Main heading of the web template

description: Main heading of the web template

description: No of items to be displayed per row

title: Root Schema


httpmockrc.json

description: A tool for mock local requests or proxy remote requests.

default: mocks

description: Root of mock files

description: Custom request header

description: Custom response header

description: Parse post body by express.json()

description: Rules for proxy and mock

description: Rule of Matching route

description: Where Mock result file located

description: Whether to ignore this rule, generally used for remote interfaces instead of mock in the local

description: How many milliseconds are delayed to return a request, general used for control the request sequence

description: Validate params in body by key and typeof value

required: mockFileName routes

title: Http-mocker configuration.