description: The package unique identifier

description: The package version

description: The package meta-data locale

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 installers in the OWC. v1.0.0

$ref: #/definitions/Channel

$ref: #/definitions/Installer

default: installer

const: installer

description: The manifest type

description: The manifest syntax version

required: PackageIdentifier PackageVersion Installers ManifestType ManifestVersion


description: A JSON representation of a Deno configuration file.

title: Deno configuration file Schema

type: object

description: Instructs the TypeScript compiler how to compile .ts files.

type: boolean

markdownDescription:
Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.

See more: https://www.typescriptlang.org/tsconfig#allowJs

description: Disable error reporting for unreachable code.

markdownDescription:
Disable error reporting for unreachable code.

See more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode

description: Disable error reporting for unused labels.

markdownDescription:
Disable error reporting for unused labels.

See more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels

description: Enable error reporting in type-checked JavaScript files.

markdownDescription:
Enable error reporting in type-checked JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#checkJs

markdownDescription:
Differentiate between undefined and not present when type checking

See more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes

description: Enable experimental support for TC39 stage 2 draft decorators.

markdownDescription:
Enable experimental support for TC39 stage 2 draft decorators.

See more: https://www.typescriptlang.org/tsconfig#experimentalDecorators

description: Specify what JSX code is generated.

default: react

enum: preserve react react-jsx react-jsxdev react-native

type: string

markdownDescription:
Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

See more: https://www.typescriptlang.org/tsconfig#jsxFactory

markdownDescription:
Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

See more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory

description: Specify module specifier used to import the JSX factory functions when using jsx: 'react-jsx*'.

markdownDescription:
Specify module specifier used to import the JSX factory functions when using jsx: `react-jsx*`.

See more: https://www.typescriptlang.org/tsconfig/#jsxImportSource

markdownDescription:
Make keyof only return strings instead of string, numbers or symbols. Legacy option.

See more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly

type: array

markdownDescription:
Specify a set of bundled library declaration files that describe the target runtime environment.

See more: https://www.typescriptlang.org/tsconfig#lib

description: Do not truncate error messages.

markdownDescription:
Do not truncate error messages.

See more: https://www.typescriptlang.org/tsconfig#noErrorTruncation

markdownDescription:
Enable error reporting for fallthrough cases in switch statements.

See more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch

markdownDescription:
Enable error reporting for expressions and declarations with an implied `any` type..

See more: https://www.typescriptlang.org/tsconfig#noImplicitAny

markdownDescription:
Ensure overriding members in derived classes are marked with an override modifier.

See more: https://www.typescriptlang.org/tsconfig#noImplicitOverride

markdownDescription:
Enable error reporting for codepaths that do not explicitly return in a function.

See more: https://www.typescriptlang.org/tsconfig#noImplicitReturns

description: Enable error reporting when `this` is given the type `any`.

markdownDescription:
Enable error reporting when `this` is given the type `any`.

See more: https://www.typescriptlang.org/tsconfig#noImplicitThis

markdownDescription:
Disable adding 'use strict' directives in emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict

markdownDescription:
Disable strict checking of generic signatures in function types.

See more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks

description: Enable error reporting when a local variables aren't read.

markdownDescription:
Enable error reporting when a local variables aren't read.

See more: https://www.typescriptlang.org/tsconfig#noUnusedLocals

description: Raise an error when a function parameter isn't read

markdownDescription:
Raise an error when a function parameter isn't read

See more: https://www.typescriptlang.org/tsconfig#noUnusedParameters

description: Add `undefined` to a type when accessed using an index.

markdownDescription:
Add `undefined` to a type when accessed using an index.

See more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess

description: Enable all strict type checking options.

markdownDescription:
Enable all strict type checking options.

See more: https://www.typescriptlang.org/tsconfig#strict

markdownDescription:
Check that the arguments for `bind`, `call`, and `apply` methods match the original function.

See more: https://www.typescriptlang.org/tsconfig#strictBindCallApply

markdownDescription:
When assigning functions, check to ensure parameters and the return values are subtype-compatible.

See more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes

markdownDescription:
Check for class properties that are declared but not set in the constructor.

See more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization

description: When type checking, take into account `null` and `undefined`.

markdownDescription:
When type checking, take into account `null` and `undefined`.

See more: https://www.typescriptlang.org/tsconfig#strictNullChecks

markdownDescription:
Disable reporting of excess property errors during the creation of object literals.

See more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors

markdownDescription:
Suppress `noImplicitAny` errors when indexing objects that lack index signatures.

See more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors

description: The location of an import map to be used when resolving modules. If an import map is specified as an `--importmap` flag or using "imports" and "scopes" properties, they will override this value.

description: A map of specifiers to their remapped specifiers.

description: The key is the specifier or partial specifier to match, with a value that represents the target specifier.

description: Define a scope which remaps a specifier in only a specified scope

description: A definition of a scoped remapping.

description: The key is the specifier or partial specifier to match within the referring scope, with a value that represents the target specifier.

description: List of files, directories or globs that will be ignored by all other configurations. Requires Deno 1.34 or later.

description: Configuration for linter

description: List of files, directories or globs that will be linted.

description: List of files, directories or globs that will not be linted.

description: List of tag names that will be run. Empty list disables all tags and will only use rules from `include`.

description: List of rule names that will be excluded from configured tag sets. If the same rule is in `include` it will be run.

description: List of rule names that will be run. Even if the same rule is in `exclude` it will be run.

default: pretty

enum: pretty json compact

description: The default report format to use when linting

description: Configuration for formatter

description: List of files, directories or globs that will be formatted.

description: List of files, directories or globs that will not be formatted.

description: Whether to use tabs (true) or spaces (false) for indentation.

description: The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

type: number

description: The number of characters for an indent.

description: Whether to use single quote (true) or double quote (false) for quotation.

description: Define how prose should be wrapped in Markdown files.

default: always

enum: always never preserve

description: Whether to prefer using semicolons.

description: The number of characters for an indent.

description: Whether to prefer using semicolons.

description: Enables or disables the use of a local node_modules folder for npm packages. Alternatively, use the `--node-modules-dir` flag or override the config via `--node-modules-dir=false`. Requires Deno 1.34 or later.

description: UNSTABLE: Enables or disables the use of a local vendor folder as a local cache for remote modules and node_modules folder for npm packages. Alternatively, use the `--vendor` flag or override the config via `--vendor=false`. Requires Deno 1.36.1 or later.

description: Configuration for deno task

description: Command to execute for this task name.

description: Configuration for deno test

description: List of files, directories or globs that will be searched for tests.

description: List of files, directories or globs that will not be searched for tests.

description: Configuration for deno bench

description: List of files, directories or globs that will be searched for benchmarks.

description: List of files, directories or globs that will not be searched for benchmarks.

description: Whether to use a lock file or the path to use for the lock file. Can be overridden by CLI arguments.


vsix-manifestinjection.json

required: extension progId

description: Content type of the file with this extension.

description: The registry path to where this file association should be registered with default program.

description: The file extension.

description: Indicates whether this file association is used for display icons only.

description: Perceived type of the file with this extension.

description: The matching /progId/id that's associated with this file extension.

description: The registry path to where this url association should be registered with default program.

description: The name of the association.

description: Id for localization purpose only.

description: The matching /progId/id that's associated with this protocol.

description: The URL protocol to associate.

description: Indicates whether silent default takeover is allowed.

description: Indicates if extensions should always be shown in Windows Explorer.

description: App user model ID for taskbar and jump list grouping.

description: Arguments to pass to the executable.

description: CLSID for the progId

description: Indicates whether application needs to support DDE.

description: DDE application name.

description: DDE topic name.

description: Default icon resource DLL path.

description: Default icon position.

type: integer

description: The name of progId.

description: Icon handler GUID.

description: The unique identifier.

description: Id for localization purpose only.

description: The path to the executable.

description: A list of file associations (protocol handlers).

$ref: #/definitions/fileAssociation

description: A list of URL associations (protocol handlers).

$ref: #/definitions/urlAssociation

$ref: #/definitions/progIds

title: JSON schema for Visual Studio manifest extensions


jdt.json

description: Use JSONPath syntax to navigate to the node where the transform should be applied.

description: The transformation value that should be applied.

description: Renames nodes

description: Renames nodes

type: array object

description: Replaces the current node with the given value.

type: array boolean object string

description: Removes the node with the given name from the current level.

type: boolean integer null number object string

description: Merges the current node value with the given object.

type: object array

title: JSON schema for JSON Document Transforms


yarnrc.json

title: JSON Schema for Yarnrc files

description:
Yarnrc files (named this way because they must be called `.yarnrc.yml`) are the one place where you'll be able to configure Yarn's internal settings. While Yarn will automatically find them in the parent directories, they should usually be kept at the root of your project (often your repository). **Starting from the v2, they must be written in valid Yaml and have the right extension** (simply calling your file `.yarnrc` won't do).

Environment variables can be accessed from setting definitions by using the `${NAME}` syntax when defining the values. By default Yarn will require the variables to be present, but this can be turned off by using either `${NAME-fallback}` (which will return `fallback` if `NAME` isn't set) or `${NAME:-fallback}` (which will return `fallback` if `NAME` isn't set, or is an empty string).

Finally, note that most settings can also be defined through environment variables (at least for the simpler ones; arrays and objects aren't supported yet). To do this, just prefix the names and write them in snake case: `YARN_CACHE_FOLDER` will set the cache folder (such values will overwrite any that might have been defined in the RC files - use them sparingly).

__info: This file contains the JSON Schema for Yarnrc files and is:

__info: 1) Hosted on the Yarn Website at http://yarnpkg.com/configuration/yarnrc.json

__info: 2) Registered on the SchemaStore catalog so that editors can offer autocompletion and validation.

__info: 3) Used to generate the documentation page at http://yarnpkg.com/configuration/yarnrc

__info: Note: Properties prefixed with a single underscore (e.g. _exampleItems, _exampleKeys)

__info: are unique to our documentation generation interpreter. All others will be picked up

__info: 1) Don't set a default if it's null, dynamic, or an object.

__info: 2) Use `examples` for scalars, `_exampleItems` for arrays, and `_exampleKeys` for objects.

__info: 3) Always add a _package property to each configuration setting.

title: Path where the downloaded packages are stored on your system.

description: They'll be normalized, compressed, and saved under the form of zip archives with standardized names. The cache is deemed to be relatively safe to be shared by multiple projects, even when multiple Yarn instances run at the same time on different projects. For setting a global cache folder, you should use `enableGlobalCache` instead.

format: uri-reference

title: Behavior that Yarn should follow when it detects that a cache entry is outdated.

description:
Whether or not a cache entry is outdated depends on whether it has been built and checksumed by an earlier release of Yarn, or under a different compression settings. Possible behaviors are:

- If `required-only`, it'll keep using the file as-is, unless the version that generated it was decidedly too old.
- If `match-spec`, it'll also rebuild the file if the compression level has changed. If `always`, it'll always regenerate the cache files so they use the current cache version.
- If `auto` (the default), it'll act as either `required-only` or `always` depending on whether `enableGlobalCache` is enabled (with `always` being selected in that case).

enum: required-only match-spec always auto

default: auto

title: Path to a file containing one or multiple Certificate Authority signing certificates.

title: List of git refs against which Yarn will compare your branch when it needs to detect changes.

description: Supports git branches, tags, and commits. The default configuration will compare against master, origin/master, upstream/master, main, origin/main, and upstream/main.

default: master origin/master upstream/master main origin/main upstream/main

title: Array of file glob patterns that will be excluded from change detection.

description: Files matching the following patterns (in terms of relative paths compared to the root of the project) will be ignored by every command checking whether files changed compared to the base ref (this include both `yarn version check` and `yarn workspaces foreach --since`).

title: Behavior that Yarn should follow when it detects that a cache entry has a different checksum than expected.

description:
Possible behaviors are:

- If `throw` (the default), Yarn will throw an exception.
- If `update`, the lockfile will be updated to match the cached checksum.
- If `reset`, the cache entry will be purged and fetched anew.
- If `ignore`, nothing will happen, Yarn will skip the check.

enum: throw update ignore reset

default: throw

title: Amount of `git clone` operations that Yarn will run at the same time.

description: We by default limit it to 2 concurrent clone operations.

type: number string

title: Compression level employed for zip archives

description: Possible values go from 0 ("no compression, faster") to 9 ("heavy compression, slower"). The default is 'mixed', which is a variant of 9 where files may be stored uncompressed if the builtin libzip heuristic thinks it will lead to a more sensible result.

default: mixed

title: Path of the constraints file.

description: This only matters for Prolog constraints, which are being deprecated. JavaScript constraints will always be read from the `yarn.config.js` file.

title: Default language mode that should be used when a package doesn't offer any insight.

description: This is an internal configuration setting that shouldn't be touched unless you really know what you're doing.

default: node

title: Default protocol that should be used when a dependency range is a pure semver range.

default: npm:

title: Default prefix used in semver ranges created by `yarn add` and similar commands.

description: Possible values are `"^"` (the default), `"~"` or `""`.

title: Folder where the versioning files are stored.

title: Define whether colors are allowed on the standard output.

description: The default is to check the terminal capabilities, but you can manually override it to either `true` or `false`.

title: Define whether the cache should be shared between all local projects.

description: If true (the default), Yarn will store the cache files into a folder located within `globalFolder` instead of respecting `cacheFolder`.

title: Define whether hyperlinks are allowed on the standard output.

title: Define whether to allow adding/removing files from the cache or not.

description: If true, Yarn will refuse to change the cache in any way, whether it would add files or remove them, and will abort installs instead of letting that happen.

title: Define whether to allow adding/removing entries from the lockfile or not.

description: If true (the default on CI), Yarn will refuse to change the lockfile in any way, whether it would add new entries or remove them. Other files can be added to the checklist via the `immutablePatterns` setting.

title: Define whether to print the build output directly within the terminal or not.

description: If true (the default on CI environments), Yarn will print the build output directly within the terminal instead of buffering it in an external log file. Note that by default Yarn will attempt to use collapsible terminal sequences on supporting CI providers to make the output more legible.

title: Define whether to print patch hunks directly within the terminal or not.

description: If true, Yarn will print any patch sections (hunks) that could not be applied successfully to the terminal.

title: Define whether to prepend a message name before each printed line or not.

description: If true, Yarn will prefix most messages with codes suitable for search engines, with hyperlink support if your terminal allows it.

title: Define whether to mirror local cache entries into the global cache or not.

description: If true (the default), Yarn will use the global folder as indirection between the network and the actual cache. This is only useful if `enableGlobalCache` is explicitly set to `false`, as otherwise the cache entries are persisted to the global cache no matter what.

title: Define whether remote network requests are allowed or not.

description: If false, Yarn will never make any request to the network by itself, and will throw an exception rather than let it happen. It's a very useful setting for CI, which typically want to make sure they aren't loading their dependencies from the network by mistake.

title: Define whether animated progress bars should be shown or not.

description: If true (the default outside of CI environments), Yarn will show progress bars for long-running events.

titke: Define whether to run postinstall scripts or not.

description:
If false, Yarn will not execute the `postinstall` scripts from third-party packages when installing the project (workspaces will still see their postinstall scripts evaluated, as they're assumed to be safe if you're running an install within them).

Note that you also have the ability to disable scripts on a per-package basis using `dependenciesMeta`, or to re-enable a specific script by combining `enableScripts` and `dependenciesMeta`.

title: Define whether SSL errors should fail requests or not.

description: If false, SSL certificate errors will be ignored

title: Define whether anonymous telemetry data should be sent or not.

description:
If true (the default outside of CI environments), Yarn will periodically send anonymous data to our servers tracking some usage information such as the number of dependencies in your project, how many installs you ran, etc.

Consult the [Telemetry](/advanced/telemetry) page for more details about this process.

title: Define whether to print the time spent running each sub-step or not.

description: If false, Yarn will not print the time spent running each sub-step when running various commands. This is only needed for testing purposes, when you want each execution to have exactly the same output as the previous ones.

title: Define whether pure semver ranges should allow workspace resolution or not.

description:
If false, Yarn won't link workspaces just because their versions happen to match a semver range. Disabling this setting will require all workspaces to reference one another using the explicit `workspace:` protocol.

This setting is usually only needed when your project needs to use the published version in order to build the new one (that's for example what happens with Babel, which depends on the latest stable release to build the future ones).

title: Path where all files global to the system will be stored.

description: Various files we be stored there: global cache, metadata cache, ...

title: Proxy to use when making an HTTP request.

description: Only HTTP proxies are supported at the moment.

format: uri

title: Amount of time to wait in seconds before retrying a failed HTTP request.

title: Amount of time to wait in milliseconds before cancelling pending HTTP requests.

title: Path to a file containing a certificate chain in PEM format.

title: Path to a file containing a private key in PEM format.

title: Define a proxy to use when making an HTTPS request.

title: Define whether `yarnPath` should be respected or not.

description: If true, whatever Yarn version is being executed will keep running rather than looking at the value of `yarnPath` to decide.

title: Array of file patterns whose content won't be allowed to change if `enableImmutableInstalls` is set.

title: Scope used when creating packages via the `init` command.

default: yarnpkg

title: Additional fields to set when creating packages via the `init` command.

type: string number boolean

description: All properties will be added verbatim to the generated package.json.

title: Path where the install state will be persisted.

description: The install state file contains a bunch of cached information about your project. It's only used for optimization purposes, and will be recreated if missing (you don't need to add it to Git).

title: Alter the log levels for emitted messages.

description: This can be used to hide specific messages, or instead make them more prominent. Rules defined there accept filtering messages by either name or raw content.

title: Match all messages with the given code.

title: Match messages whose content is strictly equal to the given text.

description: In case a message matches both `code`-based and `text`-based filters, the `text`-based ones will take precedence over the `code`-based ones.

examples: lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration

title: Match messages whose content match the given glob pattern.

description: In case a message matches both `pattern`-based and `code`-based filters, the `pattern`-based ones will take precedence over the other ones. Patterns can be overridden on a case-by-case basis by using the `text` filter, which has precedence over `pattern`.

examples: lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration

title: New log level to apply to the matching messages. Use `discard` if you wish to hide those messages altogether.

enum: info warning error discard

level: discard

level: error

title: Amount of HTTP requests that are allowed to run at the same time.

description: We default to 50 concurrent requests, but it may be required to limit it even more when working behind proxies that can't handle large amounts of traffic.

title: Additional network settings, per hostname

$ref: #/properties/httpsCaFilePath

$ref: #/properties/enableNetwork

$ref: #/properties/httpProxy

$ref: #/properties/httpsCertFilePath

$ref: #/properties/httpsKeyFilePath

$ref: #/properties/httpsProxy

title: Highest point where packages can be hoisted.

description:
Replacement of the former `nohoist` setting. Possible values are:

- If `none` (the default), packages are hoisted as per the usual rules.
- If `workspaces`, packages won't be hoisted past the workspace that depends on them.
- If `dependencies`, transitive dependencies also won't be hoisted past your direct dependencies.

This setting can be overridden on a per-workspace basis using the `installConfig.hoistingLimits` field.

enum: workspaces dependencies none

title: Define whether workspaces are allowed to require themselves.

description: If false, Yarn won't create self-referencing symlinks when using `nodeLinker: node-modules`. This setting can be overridden on a per-workspace basis using the `installConfig.selfReferences` field.

title: Define how to copy files to their target destination.

description:
Possible values are:

- If `classic`, regular copy or clone operations are performed.
- If `hardlinks-global`, hardlinks to a global content-addressable store will be used.
- If `hardlinks-local`, hardlinks will only be created between similar packages from the same project.

For compatibility with the ecosystem, the default is `classic`.

default: classic

title: Define how Node packages should be installed.

description:
Yarn supports three ways to install your project's dependencies, based on the `nodeLinker` setting. Possible values are:

- If `pnp`, a single Node.js loader file will be generated.
- If `pnpm`, a `node-modules` will be created using symlinks and hardlinks to a global content-addressable store.
- If `node-modules`, a regular `node_modules` folder just like in Yarn Classic or npm will be created.

enum: pnp pnpm node-modules

default: pnp

title: Define whether to use junctions or symlinks when creating links on Windows.

description:
Possible values are:

- If `junctions`, Yarn will use Windows junctions when linking workspaces into `node_modules` directories, which are always absolute paths.
- If `symlinks`, Yarn will use symlinks, which will use relative paths, and is consistent with Yarn's behavior on non-Windows platforms.

Symlinks are preferred, but they require the Windows user running Yarn to have the `create symbolic links` privilege. As a result, we default to using junctions instead.

enum: junctions symlinks

title: Define whether to always send authentication credentials when querying the npm registry.

description: If true, authentication credentials will always be sent when sending requests to the registries. This shouldn't be needed unless you configured the registry to reference a private npm mirror.

title: Define the registry to use when auditing dependencies.

description: If not explicitly set, the value of `npmRegistryServer` will be used.

title: Define the authentication credentials to use by default when accessing your registries.

description: Replacement of the former `_auth` setting. Because it requires storing unencrypted values in your configuration, `npmAuthToken` should be preferred when possible.

title: Define the authentication token to use by default when accessing your registries.

description: Replacement of the former `_authToken` settings. If you're using `npmScopes` to define multiple registries, the `npmRegistries` dictionary allows you to override these credentials on a per-registry basis.

title: Define the default access to use when publishing packages to the npm registry.

description: Valid values are `public` and `restricted`, but `restricted` usually requires to register for a paid plan (this is up to the registry you use). Can be overridden on a per-package basis using the `publishConfig.access` field.

title: Array of advisory ID glob patterns of packages to exclude from `yarn npm audit`.

title: Array of advisory ID glob patterns to ignore from `yarn npm audit` results.

title: Define the registry to use when pushing packages.

description: If not explicitly set, the value of `npmRegistryServer` will be used. Overridden by `publishConfig.registry`.

title: Per-registry configurations.

title: Define the registry to use when fetching packages.

description: Should you want to define different registries for different scopes, see `npmScopes`. To define the authentication scheme for your servers, see `npmAuthToken`. The url must use HTTPS by default, but this can be changed by adding it to the `unsafeHttpWhitelist`.

title: Per-scope registry configurations.

title: Extend the package definitions of your dependencies; useful to fix third-party issues.

description:
Some packages may have been specified incorrectly with regard to their dependencies - for example with one dependency being missing, causing Yarn to refuse it the access. The `packageExtensions` fields offer a way to extend the existing package definitions with additional information. If you use it, consider sending a PR upstream and contributing your extension to the [`plugin-compat` database](https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts).

Note: This field is made to add dependencies; if you need to rewrite existing ones, prefer the `resolutions` field instead.

description: Each key is a descriptor covering a semver range. The extensions will be applied to any package whose version matches the specified range. This is true regardless of where the package comes from, so no distinction on whether they come from git or a registry, for example. Only the version matters.

title: Folder where patch files will be written to.

title: Define whether to generate a Node.js ESM loader or not.

description: If true, Yarn will generate an experimental ESM loader (`.pnp.loader.mjs`) on top of the CJS one.

title: Define whether to store the PnP data in the generated file or not.

description: If false, Yarn will generate an additional `.pnp.data.json` file.

title: Define whether to allow packages to rely on the builtin PnP fallback mechanism.

description:
Possible values are:

- If `all`, all packages can access dependencies made available in the fallback.
- If `dependencies-only` (the default), dependencies will have access to them but not your workspaces.
- If `none`, no packages will have access to them.

title: Array of file glob patterns that should be forced to use the default CommonJS resolution.

description: Files matching those locations will not be covered by PnP and will use the regular Node.js resolution algorithm. Typically only needed if you have subprojects that aren't yet part of your workspace tree.

title: Define whether to attempt to simulate traditional `node_modules` hoisting.

description:
Possible values are:

- If `strict` (the default), modules won't be allowed to require packages they don't explicitly list in their own dependencies.
- If `loose`, packages will be allowed to access any other package that would have been hoisted to the top-level under 1.x installs.

Note that, even in loose mode, hoisted require calls are unsafe and should be discouraged.

title: String prepended to the generated PnP loader.

title: Path where unplugged packages are stored.

description: While Yarn attempts to reference and load packages directly from their zip archives, it may not always be possible. In those cases, Yarn will extract the files to the unplugged folder.

title: Define whether to use deferred versioning by default or not.

description: If true, deferred versioning by default when running the `yarn version` family of commands.

title: Define whether to use interactive prompts by default or not.

description: If true, Yarn will ask for your guidance when some actions would be improved by being disambiguated. Enabling this setting also unlocks some features (for example the `yarn add` command will suggest to reuse the same dependencies as other workspaces if pertinent).

title: Define whether to reuse most common dependency ranges or not when adding dependencies to a package.

description: If true, `yarn add` will attempt to reuse the most common dependency range in other workspaces.

title: Define whether to truncate lines that would go beyond the size of the terminal or not.

description: If true, Yarn will truncate lines that would go beyond the size of the terminal. If progress bars are disabled, lines will never be truncated.

title: Style of progress bar to use.

title: Systems for which Yarn should install packages.

title: List of operating systems to cover.

title: List of CPU architectures to cover.

description: See https://nodejs.org/docs/latest/api/process.html#processarch for the architectures supported by Node.js

title: The list of standard C libraries to cover.

title: Define the minimal amount of time between two telemetry events, in days.

description: By default we only send one request per week, making it impossible for us to track your usage with a lower granularity.

title: User-defined unique ID to send along with telemetry events.

description:
The default settings never assign unique IDs to anyone, so we have no way to know which data originates from which project. This setting can be used to force a user ID to be sent to our telemetry server.

Frankly, it's only useful in some very specific use cases. For example, we use it on the Yarn repository in order to exclude our own usage from the public dashboards (since we run Yarn far more often here than anywhere else, the resulting data would be biased).

title: Define whether to automatically install @types dependencies.

description: If true, Yarn will automatically add `@types` dependencies when running `yarn add` with packages that don't provide their own typings (as reported by the Algolia npm database). This behavior is enabled by default if you have a tsconfig file at the root of your project.

title: Array of hostname glob patterns for which using the HTTP protocol is allowed.

title: Path where virtual packages will be stored.

description: Due to a particularity in how Yarn installs packages which list peer dependencies, some packages will be mapped to multiple virtual directories that don't actually exist on the filesystem. This settings tells Yarn where to put them. Note that the folder name *must* be `__virtual__`.

title: Path of a Yarn binary to use instead of the global one.

description:
This binary will be executed instead of any other (including the global one) for any command run within the directory covered by the rc file. If the file extension ends with `.js` it will be required, and will be spawned in any other case.

The `yarnPath` setting used to be the preferred way to install Yarn within a project, but we now recommend to use [Corepack](https://nodejs.org/api/corepack.html) in most cases.


pubspec.json

description: Version range of the package or SDK to use

description: Allows any version of the package. This is not recommended for performance reasons

$ref: #/definitions/version

$ref: #/definitions/versionConstraint

$comment: Syntax in yaml: `foo: ^1.2.3`

description: Default dependency, matches any version of the package

$comment: Syntax in yaml: `foo:` or `foo: null`

title: SDK dependency

description: The SDK which contains this package

title: Hosted dependency

description: URL of the package server hosting this package

description: The package server hosting this package

description: Git dependency

$comment: Can either be a string (uri) or an object with ref etc.

description: URI of the repository hosting this package

description: Path of this package relative to the Git repo's root

description: The branch, tag, or anything else Git allows to identify a commit.

description: Path dependency

$ref: #/definitions/dependency

description: Dart Pubspec file

description: The name of this package. The name is how other packages refer to yours, should you publish it.

$ref: #/definitions/dependencies

title: Pubspec


samtrc.json

enum: error warn info off

description: The name of the configuration file to extend from, used to determine the default rules to apply

enum: recommended strict

description: Configuration for linter rules for the current project

description: Configure whether model types (e.g. record and service) must be in a separate file from their providers and consumers

const: split-model-and-providers

description: Configure naming rules which apply to all types in the project

const: naming-conventions


description: SWADL (Symphony Workflow Automation Definition Language) is a language to describe workflows on Symphony.

required: id activities

description: Workflow's id should start with a letter. It is optional. If no id is provided, the workflow filename is used. Otherwise, it will be generated. The id will appear in logs and audit trails.

default: my-workflow

description: Some metadata about the workflow

type: boolean string

description: Should the workflow be published or not, true publish, false otherwise

description: Variables are accessible and editable within the entire workflow. A map of key: value entries is expected.

description: A list of activities to be executed by the workflow. By default the execution is sequential but complex logic can be orchestrated with if/else conditions as well as on/activity-completed events.

$comment: Defined like this to support both validation and autocompletion, even with custom activities. Last item is removed on the fly during validation and replaced by known custom activities.

description: Creates a new chatroom.

x-intellij-html-description:
Creates a new chatroom.

https://developers.symphony.com/restapi/reference#create-room-v3

$ref: #/definitions/basic-activity-inner

$ref: #/definitions/create-room-inner

description: Updates the attributes of an existing chat room.

x-intellij-html-description:
Updates the attributes of an existing chat room.

https://developers.symphony.com/restapi/reference#update-room-v3

$ref: #/definitions/update-room-inner

description: Adds new members to an existing room.

x-intellij-html-description:
Adds a new members to an existing room.

https://developers.symphony.com/restapi/reference#add-member

$ref: #/definitions/add-room-member-inner

description: Removes members from an existing room.

x-intellij-html-description:
Removes members from an existing room.

https://developers.symphony.com/restapi/reference#remove-member

$ref: #/definitions/remove-room-member-inner

description: Promotes user to owner of the chat room.

x-intellij-html-description:
Promotes user to owner of the chat room.

https://developers.symphony.com/restapi/reference#promote-owner

$ref: #/definitions/promote-room-owner-inner

description: Demotes room owner to a participant in the chat room.

x-intellij-html-description:
Demotes room owner to a participant in the chat room.
https://developers.symphony.com/restapi/reference#demote-owner

$ref: #/definitions/demote-room-owner-inner

description: Posts a message to a stream.

x-intellij-html-description:
Posts a message to a stream.
https://developers.symphony.com/restapi/reference#create-message-v4

$ref: #/definitions/send-message-inner

description: Updates an existing message into a stream.

x-intellij-html-description:
Updates an existing message into a stream.
https://developers.symphony.com/restapi/reference#update-message-v4

$ref: #/definitions/update-message-inner

description: Pin an existing message into the stream it belongs to.

x-intellij-html-description: Pin an existing message into the stream it belongs to.https://developers.symphony.com/restapi/reference#update-room-v3(https://developers.symphony.com/restapi/v20.13/reference#update-im

$ref: #/definitions/pin-message-inner

description: Unpin any message (if present) from an existing stream.

x-intellij-html-description:
Unpin any message (if present) from an existing stream.
https://developers.symphony.com/restapi/reference#update-room-v3(https://developers.symphony.com/restapi/v20.13/reference#update-im

$ref: #/definitions/unpin-message-inner

description: Gets one attachment and stores it locally.

x-intellij-html-description:
Gets one attachment and stores it locally.
https://developers.symphony.com/restapi/reference#attachment

$ref: #/definitions/get-attachment-inner

description: Standard debug activity.

x-intellij-html-description: Standard debug activity.

description: Activity's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.

$comment: variables is forbidden to avoid conflict with variables.output... that would override the workflows variables

$ref: #/definitions/on

description: Conditional execution of the activity based on a boolean expression.

description: Default execution of the activity when if conditions are used for previous activities.

type: object string

description: Executes a Groovy script.

x-intellij-html-description: Executes a Groovy script.

$ref: #/definitions/execute-script-inner

description: Executes an HTTP request.

$ref: #/definitions/execute-request-inner

description: Creates a new end user.

x-intellij-html-description:
Creates a new end user.
https://developers.symphony.com/restapi/reference#create-user-v2

$ref: #/definitions/create-user-inner

required: email username firstname lastname display-name

description: Updates an existing end user.

x-intellij-html-description:
Updates an existing end user.
https://developers.symphony.com/restapi/reference#update-user-v2

$ref: #/definitions/user-id

description: Creates a new service user.

x-intellij-html-description:
Creates a new service user.
https://developers.symphony.com/restapi/reference#create-user-v2

$ref: #/definitions/create-system-user-inner

required: email username display-name

description: Updates an existing service user.

x-intellij-html-description:
Updates an existing service user.
https://developers.symphony.com/restapi/reference#update-user-v2

description: Adds roles to user accounts.

x-intellij-html-description:
Adds a role or optional entitleable action to a user’s account.
https://developers.symphony.com/restapi/reference#add-role

$ref: #/definitions/user-role-inner

description: Removes roles from user accounts.

x-intellij-html-description:
Removes a role or optional entitleable action from a user’s account.
https://developers.symphony.com/restapi/reference#remove-role

description: Returns details for a particular user.

x-intellij-html-description:
Returns details for a particular user.
https://developers.symphony.com/restapi/reference#get-user-v2

$ref: #/definitions/get-user-inner

description: Returns a list of users ID, including user metadata.

x-intellij-html-description:
Returns a list of users ID, including user metadata.
https://developers.symphony.com/restapi/reference#users-lookup-v3

$ref: #/definitions/get-users-inner

description: Returns information about a particular stream.

x-intellij-html-description:
Returns information about a particular stream.
https://developers.symphony.com/restapi/reference#stream-info-v2</html

$ref: #/definitions/get-stream-inner

description: Returns information about a particular chat room.

x-intellij-html-description:
Returns information about a particular chat room.
https://developers.symphony.com/restapi/reference#room-info-v3

$ref: #/definitions/get-room-inner

description: Returns a message found by id.

x-intellij-html-description:
Returns a message found by id.
https://developers.symphony.com/restapi/reference#get-message-v1

$ref: #/definitions/get-message-inner

description: Returns a list of all the current members of a stream (IM, MIM, or chatroom).

x-intellij-html-description:
Returns a list of all the current members of a stream (IM, MIM, or chatroom).
https://developers.symphony.com/restapi/reference#stream-members

$ref: #/definitions/get-stream-members-inner

description: Lists the current members of an existing room.

x-intellij-html-description:
Lists the current members of an existing room.
https://developers.symphony.com/restapi/reference#room-members

$ref: #/definitions/get-room-members-inner

description: Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).

x-intellij-html-description:
Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).
https://developers.symphony.com/restapi/reference#list-user-streams

$ref: #/definitions/get-user-streams-inner

x-intellij-html-description:
Returns a list of all the streams (IMs, MIMs, and chatrooms) for the calling user's company, sorted by creation date (ascending – oldest to newest).
https://developers.symphony.com/restapi/reference#list-streams-for-enterprise-v2

$ref: #/definitions/get-streams-inner

description: Get one connection status.

x-intellij-html-description:
Get one connection status.
https://developers.symphony.com/restapi/reference#get-connection

$ref: #/definitions/connection-inner

description: Send a connection request to another user.

x-intellij-html-description:
Send a connection request to another user.
https://developers.symphony.com/restapi/reference#create-connection

description: Accept the connection request for a requesting user.

x-intellij-html-description:
Accept the connection request for a requesting user.
https://developers.symphony.com/restapi/reference#accepted-connection

description: Reject the connection request from a requesting user.

x-intellij-html-description:
Reject the connection request from a requesting user.
https://developers.symphony.com/restapi/reference#reject-connection

description: Remove a connection with a user.

x-intellij-html-description:
Remove a connection with a user.
https://developers.symphony.com/restapi/reference#remove-connection

description: Search for rooms, querying name, description, and specified keywords.

x-intellij-html-description:
Search for rooms, querying name, description, and specified keywords.
https://developers.symphony.com/restapi/reference#search-rooms-v3

description:
Get messages from an existing stream (IM, MIM, or chatroom).
Additionally returns any attachments associated with the message.

x-intellij-html-description:
Get messages from an existing stream (IM, MIM, or chatroom).
Additionally returns any attachments associated with the message.
https://developers.symphony.com/restapi/reference#messages-v4

description: Get one or multiple connections statuses

x-intellij-html-description:
Get one or multiple connections statuses
https://developers.symphony.com/restapi/reference#list-connections

description: Create a group (distribution list)

x-intellij-html-description:
Create a group (distribution list)
https://developers.symphony.com/restapi/reference/insertgroup

description: Update a group (distribution list)

x-intellij-html-description:
Update a group (distribution list)
https://developers.symphony.com/restapi/reference/updategroup

description: Retrieve a group (distribution list)

x-intellij-html-description:
Retrieve a group (distribution list)
https://developers.symphony.com/restapi/reference/getgroup

description: Retrieve groups of specified type (distribution list)

x-intellij-html-description:
Retrieve groups of specified type (distribution list)
https://developers.symphony.com/restapi/reference/listgroups

description: Add members to a group (distribution list)

x-intellij-html-description:
Add members to a group (distribution list)
https://developers.symphony.com/restapi/reference/addmembertogroup

$comment: Match everything that is not an already known activity to allow for custom activities to be used.

description: If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

description: If true, it searches for active users only. If false, it searches for inactive users only. If not set, it searches for all users regardless of their status.

description: Events that can trigger the activity execution.

x-intellij-html-description:
Events that can trigger the activity execution.
List of real-time events: https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events

description: Timeout while waiting for form-replied events, expressed as an ISO 8601 duration. Default value is 24 hours.

x-intellij-html-description:
Generated when a user replies to a bot message that contains an interactive form with UX components such as text fields, radio buttons, checkboxes, person selectors and more. Please refer to Symphony Elements.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#symphony-elements-action

title: object

description: Generated when an HTTP request is received in order to trigger a workflow.

x-intellij-html-description:
Generated when a message is sent in an IM, MIM, or chatroom of which the workflow bot is a member, including messages sent by the user him/herself.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#message-sent

description: Generated when messages are suppressed.

x-intellij-html-description:
Generated when messages are suppressed.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#messages-suppressed

description: Generated when either the workflow bot shares a wall post written by another user or another user shares a wall post written by the workflow bot.

x-intellij-html-description:
Generated when either:
The workflow bot shares a wall post written by another user.

Another user shares a wall post written by the workflow bot.

https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#shared-wall-posts

description: Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.

x-intellij-html-description:
Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#im-mim-created

description: Generated when a room is created by the workflow bot.

x-intellij-html-description:
Generated when a room is created by the workflow bot.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-created

description: Generated when a room of which the workflow bot is a member is updated, including rooms updated by the user him/herself.

x-intellij-html-description:
Generated when a room of which the workflow bot is a member is updated, including rooms updated by the user him/herself.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-updated-message

description: Generated when a room of which the workflow bot is a member is deactivated, including rooms deactivated by the user him/herself.

x-intellij-html-description:
Generated when a room of which the workflow bot is a member is deactivated, including rooms deactivated by the user him/herself.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-deactivated-message

description: Generated when a room of which the workflow bot is a member is reactivated, including rooms reactivated by the user him/herself.

x-intellij-html-description:
Generated when a room of which the workflow bot is a member is reactivated, including rooms reactivated by the user him/herself.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-reactivated-message

x-intellij-html-description:
Generated when a user is promoted from a participant to an owner of a room of which the workflow bot is a member, including when the user himself is promoted to an owner or promotes another user.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-promoted-to-owner

x-intellij-html-description:
Generated when a user is demoted from an owner to a participant of a room of which the workflow bot is a member, including when the user himself is demoted to a participant or demotes another user.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-demoted-from-owner

x-intellij-html-description:
Generated when a new user joins or is added to a room of which the workflow bot is a member, including when the user himself joins or is added to a room.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-joined-room

x-intellij-html-description:
Generated when a user leaves or is removed from a room of which the workflow bot is a member, including when the user himself leaves or is removed from a room.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-left-room

x-intellij-html-description:
Generated when a user requests to join a room. Only the user who requested to join the room and the owners of that room will receive this event on their datafeeds.
https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-requested-to-join-room

description: Generated when a connection request is sent, either by the workflow bot to another user or to the workflow bot by another user.

x-intellij-html-description:
Generated when a connection request is sent, either:
Sent by the workflow bot to another user.

Sent to the workflow bot by another user.

https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-requested

description: Generated when a connection request is accepted, either sent by the workflow bot and accepted by another user or sent by another user and accepted by the workflow bot.

x-intellij-html-description:
Generated when a connection request is accepted, either:
Sent by the workflow bot and accepted by another user.

Sent by another user and accepted by the workflow bot.

https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-accepted

description: Generated when the given activity event timeout has expired. Note this is not a Datafeed real-time event.

description: Generated when the given activity has failed. Note this is not a Datafeed real-time event.

description: Generated when the given activity is completed. Note this is not a Datafeed real-time event.

x-intellij-html-description: Generated when the given activity is completed. Note this is not a Datafeed real-time event.

description: Used to receive all listed events.

description: Used to receive at least one of the listed events.

x-intellij-html-description: Used to receive at least one of the listed events.

description: Timer based event. It is either triggered at a given point in time using the keyword "at" or repeated using the keyword "repeat". Note this is not a Datafeed real-time event.

x-intellij-html-description:
Timer based event. It is either triggered at:
a given point in time using the keyword "at".

repeated using the keyword "repeat".
 Note this is not a Datafeed real-time event.

description: ISO 8601 repeating intervals to repeat the current activity.

description: ISO 8601 date representing a point in time when the current activity should be executed.

description: Form's id. The id should be the same as activity's one that sent the form.

description: True if only one reply is expected to the form. Default is false

description: Message content to listen to.

description: If true, the event is only triggered if the bot is mentioned.

description: Event's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.

description: Token to authorize incoming http requests.

description: The expiring activity triggering this event.

description: The failing activity triggering this event.

description: The completed (without errors) activity triggering this event.

description: Inner property having common properties for every activity.

description: Room's name. Room names will be considered the same if they only differ in capitalization and whitespace. E.g. "room1" and "R O O M 1" are considered the same. Also, room names must be shorter than 50 characters.

description: Room's description.

description: A list of key-value pairs, describing additional properties of the room.

description: If true, any chat room participant can add new participants. If false, only owners can add new participants.

description: If true, this chat room (name, description and messages) non-participants can search for this room. If false, only participants can search for this room.

description:
If true, this is a public chatroom. If false, a private chatroom.
Note: Once this value is set for a room, it is read-only and can’t be updated.

description:
If true, only stream owners can send messages.
Note: Once this value is set for a room, it is read-only and can’t be updated.

x-intellij-html-description:
If true, only stream owners can send messages.
Note: Once this value is set for a room, it is read-only and can’t be updated.

description:
If true, users cannot copy content from this room.
Note: Once this value is set to true for a room, it is read-only and can’t be updated.

x-intellij-html-description:
If true, users cannot copy content from this room.
Note: Once this value is set to true for a room, it is read-only and can’t be updated.

description: If true, this room is a cross-pod room.

description: If true, new members can view the room chat history of the room.

description: If true, this is a multilateral room where users belonging to more than 2 companies can be found.

description: If false, the room is not active anymore.

description: Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made

description: Stream's id to update.

description: Stream id where to add user(s).

description: User ids to add to the room.

description: Stream id where to remove user(s).

description: User ids to remove from the room.

description: Stream id where to promote user.

description: User ids to promote in the room.

description: Stream id where to demote user.

description: User ids to demote in the room.

description: The recipient (conversation, IM, MIM or chatroom) in which the message should be posted.

description: Message data, which is a Json string and sent along with message.

description: One or more attachments to be sent along with the message.

description: If enabled, the new updated message is marked as read, otherwise is unread

description: Script to execute (only Groovy is supported)

description: Contains the host and the path to be targeted

description: If enabled, the query parameters will be encoded in application/x-www-form-urlencoded

description: HTTP method to perform

description: HTTP request body

$comment: String format is required for all content types except multipart/form-data

description: HTTP request body

$comment: Object format is required for multipart/form-data content type

description: HTTP request headers

description: Email address, must be unique

description: The user's work phone number.

description: Business information

description:
The user's company name.
If not specified, it is set with the default company name.

description: The user's department.

description: The user's division.

description: The user's title.

description: The user's location.

description: The user's job function.

enum:
Analyst
Other
Business Development Executive
Corporate Access
Developer
Director
Economist
Portfolio Manager
Project Manager
Research Analyst
Sales
Strategist
Trader

description: The user's asset classes (one or more).

enum:
Equities
Cash Equities
Securities Lending
Fixed Income
Government Bonds
Prime Brokerage
Commodities
Municipal Bonds
Currencies
Corporate Bonds

description: The user's job industries (one or more).

enum:
Healthcare
Consumer Non-Cyclicals
Transportation
Technology
Real Estate
Basic Materials
Financials
Energy & Utilities
Conglomerates
Consumer Cyclicals
Services

description: The user's job functions (one or more).

enum:
Collateral
Confirmation
Trade Processing
Pre-Matching
Margin
Matching
Claims Processing
Middle Office
Liquidity Management
Allocation
Trade Management
Regulatory Outreach
Settlements
Post Trade Management

description: The user's market coverage (one or more).

description: The user's responsibilities (one or more).

description: The user's instruments (one or more).

description: Email address, must be unique.

description: User's first name.

description: User's last name.

description: Unique identifier for the user.

description: User's display name.

description: The recommended language. As an ISO 639-1 code.

description: Contact information

description: User's work phone number.

description: User's mobile phone number.

description: User's two factor auth number.

description: User's sms phone number.

description: User's business information.

description: User's password. The password object is optional for end-user accounts (NORMAL). For example, if your organization utilizes SSO, you may not want to specify the password.

description: A base64-encoded string. The hashed password. This is the hashed version of the password the user would use to login.

description: A base64-encoded string. The salt used for hashing the hPassword.

description: A base64-encoded string. The hashed password to be used for authenticating to the key manager.

description: A base64-encoded string. The salt used for hashing the khPassword.

x-intellij-html-description:
The roles object consists of the following possibilities:
For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER

For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT

https://developers.symphony.com/restapi/reference#roles-object

description: User entitlements.

description: User status: ENABLED or DISABLED.

description: Email address, must be unique

description: User's username.

description: User's display name.

description: User's business information.

description: For SYSTEM users, to set up the RSA keys for authentication.

description: User entitlements.

description: User status: ENABLED or DISABLED.

description:
A string indicating the action to be performed on the user's RSA.

The following actions can be performed on the user's active RSA key:
SAVE
REVOKE.

The following actions can be performed onto the user's rotated RSA key:
REVOKE
EXTEND.

description: A string containing the user's RSA public key. The key must be 4096 bits. Only PKCS8 format is allowed.

description: An ISO 8601 timestamp containing the RSA key expiration date. This value is only set for rotated keys.

description: Feature entitlements to configure for the user.

description: Allows the user to read wall posts.

description: Allows the user to write wall posts.

description: Allows the user to have delegates.

description: Allows the user to chat in external IM/MIMs.

description: Allows the user to share files externally.

description: Allows the user to create internal public rooms.

description: Allows the user to edit profile picture.

description: Allows the user to chat in private external rooms.

description: Allows the user to create push signals.

description: Enables Lite Mode.

description: Must be recorded in meetings.

description: Allows the user to send files internally.

description: Allows the user to use audio in internal Meetings.

description: Allows the user to use video in internal Meetings.

description: Allows the user to share screens in internal Meetings.

description: Allows the user to view shared screens in internal Meetings.

description: Allows the user to create multi-lateral room.

description: Allows the user to join multi-lateral room.

description: Allows the user to use Firehose.

description: Allows the user to use audio in internal meetings on mobile.

description: Allows the user to use video in internal meetings on mobile.

description: Allows the user to share screens in internal meetings on mobile.

description: Allows the user to view shared screens in internal meetings on mobile.

description: Allows the user to manage signal subscriptions.

description: Can create datahose feeds.

description: Can integrate email service.

description: Can read from datahose feeds.

description: Can suppress own messages.

description: Can switch to Client 2.0 experience.

description: Can Toggle Room's Share History Property.

description: Allow user to use Agent Encrypt endpoints.

description: Can Use Swift Search.

description: Enable Developer Tools for SDA.

description: Enable Full screen access on SDA.

description: Enable location access on SDA.

description: Enable Media access on SDA.

description: Enable access to MIDI Sysex on SDA.

description: Allow notifications on SDA.

description: Allow Opening External Apps from SDA.

description: Enable Pointer Lock on SDA.

description: Users to add or remove roles from.

description: List of email addresses. Note that for this activity, you can use either the user-ids, the emails or the usernames, but only one at a time, you cannot mix and match them.

description: List of usernames. If username is specified, local must be set to true. Note that for this activity, you can use either the user-ids, the emails or the usernames, but only one at a time, you cannot mix and match them.

description: Id of the stream for which to return members.

description:
A list of stream types that will be returned. Options are IM (1-1 instant messages), MIM (multiparty instant messages), ROOM (rooms), POST (the user's wall). For more information, see the streamTypes section below.
If not specified, all types of streams are returned.

description: Whether to include inactive conversations. A chatroom is inactive if it has been deactivated by an owner or admin. An IM or MIM is inactive if one of the participating users has been deactivated by an admin. If not specified, only active streams are returned.

description: The message identifier.

description: A list of stream types that will be returned (IM, MIM, ROOM). If not specified, streams of all types are returned.

description: The scope of the stream: INTERNAL (restricted to members of the calling user's company) or EXTERNAL (including members of the calling user's company, as well as another firm). If not specified, returns streams of either scope.

description: The origin of the room: INTERNAL (created by a user of the calling user's company) or EXTERNAL (created by a user of another company). If not specified, returns streams of either origin. Only applies to chatrooms with External scope.

description: The privacy setting of the room: PRIVATE (members must be added) or PUBLIC (anyone can join). If not specified, returns both private and public rooms. Only applies to chatrooms with internal scope.

description: The status of the room: ACTIVE or INACTIVE. If not specified, both active and inactive streams are returned.

description: Restricts result set to rooms that have been modified since this date (ISO 8601). When specified along with end-date, enables the developer to specify rooms modified within a given time range.

description: Restricts result set to rooms that have been modified prior to this date (ISO 8601). When specified along with start-date, enables the developer to specify rooms modified within a given time range.

description: The query which is searched for in room name, description, and optionally keywords. Case-insensitive.

description: A list of room keywords whose values will be queried.

description: If true, it restricts the search to active rooms. If false, it restricts the search to inactive rooms. If not specified, it includes both active and inactive rooms. Note that for inactive rooms, only rooms where the calling user is a member will be in the search scope; read the box “Room Search Scope” for further details.

description: If true, it includes only private rooms in the search results. If false, only public rooms are returned. If not specified, both public and private rooms are returned. Note that for inactive rooms, only discoverable rooms and rooms where the calling user is a member will be in the search scope; read the box “Room Search Scope” for further details.

description: If provided, restrict the search to rooms created by the specified user.

description: If provided, restrict the search to rooms owned by the specified user.

description: If provided, restrict the search to rooms where the specified user is a member.

description: Sort algorithm to be used. Supports two values: BASIC (legacy algorithm) and RELEVANCE (enhanced algorithm).

description: Stream identifier.

description: Date, in ISO 8601 format, of the earliest possible data of the first message returned.

description: List of user ids that this activity results will be restricted to their connections.

description: Group type identifier (for instance SDL).

description: Group's name.

description: The type of the company new groupType.

description: Symphony, referring company name, referring channel partner name.

description: Owner id if the owner type is tenant (podId) or user (userId), otherwise null.

description: Owner type. Only TENANT supported now.

description: Member's user id.

description: Member's tenant id.

description: The display name in Directory, it is expected to be the same as group name.

description: The company name is expected to be the same as group company owner.

description: The group's asset classes (one or more).

description: The group's job industries (one or more).

description: The group's job functions (one or more).

description: The group's market coverage (one or more).

description: The group's responsibilities (one or more).

description: The group's instruments (one or more).

description: Status flag to distinguish between active and deleted objects. Required to update group fields except the image-path.

description: Required to update group fields except the image-path.

description: Path to the file to be uploaded as the group's avatar. The path is relative to the workflows folder.

description: Group type id.

description: Filter by status, active or deleted. If not specified both are returned.

description: NOT SUPPORTED YET, currently ignored. Cursor that points to the start of the current page of data. If not present, the current page is the first page.

description: Cursor that points to the end of the current page of data. If not present, the current page is the last page.

description: Numbers of items to return.

description: Group's unique identifier.

description: Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made.

description: The content of the message in MessageML format. Must contain at least one space. In case the content is a form, this latter's id should be the same as the activity one.

description: Inline template message content in string.

description: External message template file path.

description: Number of elements to be skipped during return - used for pagination.

description: Maximum number of elements to be returned - used for pagination.

description: Message identifier. Both safe url and Base64 encoded urls are accepted.

description: Stream identifier. Both safe url and Base64 encoded urls are accepted.

description: Stream id to sent the message to.

description: Stream ids to sent the message to (blast message).

description: User identifiers list.

description: List of user ids.

description: User id.

description: Message id having the attachment to forward. Both url safe and base64 encoded urls are accepted.

description: Attachment id to forward. If not set, all attachments in the provided message are forwarded. Both url safe and base64 encoded urls are accepted.

description: Path to the file to be attached to the message. The path is relative to the workflows folder.


title: ui5-workspace.yaml

description: Schema for UI5 Tooling Workspace Configuration File (ui5-workspace.yaml)

$comment: See https://sap.github.io/ui5-tooling/

errorMessage:
Unsupported "specVersion"
Your UI5 CLI installation might be outdated.
Supported specification versions: "workspace/1.0"
For details, see: https://sap.github.io/ui5-tooling/stable/pages/Workspace/#workspace-specification-versions

$ref: #/definitions/metadata

$ref: #/definitions/dependencyManagement

title: Workspace Name

description: Identifier for the workspace configuration. Workspaces named 'default' will be used automatically by UI5 Tooling

errorMessage: Not a valid workspace name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Workspace/#name


schema-kas.json

title: kas configuration

description: kas, a setup tool for bitbake based projects

required: repo file

enum: openembedded oe isar


title: api url info

title: template for all request

default: sql

title: cases to test

description: a schema for auto api cases

title: case


cityjson.min.schema.json

title: CityJSON v1.1.3

description: CityJSON specifications v1.1.3

format: email

enum: individual organization

description: from ISO 19115 codelist

enum: resourceProvider custodian owner user distributor originator pointOfContact principalInvestigator processor publisher author sponsor co-author collaborator editor mediator rightsHolder contributor funder stakeholder

required: contactName emailAddress

format: date

required: url version

description: the IDs of the parents

description: the IDs of children

required: surfaces values

required: type lod boundaries

description: the IDs of the parents

description: the IDs of children

required: type template boundaries transformationMatrix

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the role of each of the CityObjects members of that group

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

required: type transform version CityObjects vertices


curations-schema.json

title: ORT curations

description: The OSS-Review-Toolkit (ORT) provides a possibility to correct metadata and set the concluded license for a specific packages (dependencies) in curation files. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-curations-yml.md.

$ref: #/definitions/hash

required: hash url

$ref: #/definitions/vcsMatcher

required: id curations

required: value algorithm


csscomb.json

description:
A list of files to ignore in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to add missing semicolon in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A block indent style in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A hexadecimal color style in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

enum: lower upper

description:
Whether to expand hexadecimal color or use shorthand in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to unify case of element selector in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to add a trailing line break in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to add leading zero in a dimension in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A quote style in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

enum: single double

description:
Whether to remove empty rulesets
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style after a colon in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style after a combinator in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style after an opening brace in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style after a selector delimiter in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style after a closing brace in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style before a colon in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style before a combinator in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style before an opening brace in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style before a selector delimiter in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A space style between declarations in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to trim trailing space in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to remove unit in zero-valued dimension in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
Whether to align prefix in property and value in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A sort order in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

description:
A sort style of unknown properties in the current project
https://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config

title: A CSS Comb config schema


cicsts-resourcemodel.json

title: Resource model JSON Schema.

description: Super-schema that describes all versions of 'Resource model JSON Schema.'

title: Resource model JSON Schema.

description: Schema that describes the structure of a resource model document.


description: Which prop declaration method to use

enum: ts jsdoc prop-types none

description: Whether the component is meant to have children (FC) or not (VFC)

description: Wether to use Typescript

description: Whether to create a new, dedicated dir for the component (false) or not (true)

description: Which styling solution to use

enum: css scss jss mui react-native styled-components none

description: Relevant for `css` or `scss` styling. If true, generates a scoped `module` stylesheet

description: Whether to import React

description: Whether to overwrite existing files, if any are found

description: A command to run after a component was successfully generated

description: Path to a base directory which components should be genenrated in or relative to

description: The path in which the component folder/files should be generated, relative to baseDir

description: If true, allows components to be generated outside the resolved baseDir

description: Whether to use a named export or a default export for the component

enum: named default

description: Whether to declare the component as a const with an arrow function or a function declaration

enum: const function

description: For TS components, whether to declare props as an interface or a type

enum: interface type

description: Whether to generate a memo() component. Overrides the declaration option

description: Whether to use a dedicated index file (recommended)

description: Whether to generate React Native components

description: Whether to log additional debug information

description: Link to https://json.schemastore.org/agripparc-1.4.json

title: JSON schema for the Agrippa config file


meltano.schema.json

title: JSON Schema for meltano.yml

description: Meltano (https://meltano.com) is an open source platform for building, running & orchestrating ELT pipelines

$ref: #/$defs/annotations

description: A default environment to be used when one is not present as an argument or as an environment variable.

description: Share anonymous usage data with the Meltano team to help them gauge interest and allocate development time

description: A globally unique project identifier. Defaults to a Meltano-generated unique GUID for each project.

description: A database URI for the project system database. Defaults to a SQLite file stored at .meltano/meltano.db

description: The python version to use for plugins, specified as a path, or as the name of an executable to find within a directory in $PATH. If not specified, the python executable that was used to run Meltano will be used (within a separate virtual environment). This can be overridden on a per-plugin basis by setting the `python` property for the plugin.

description: Configuration for state backend.

description: The URI pointing to the backend to use.

default: systemdb

description: The number of seconds a lock on a state file is considered valid.

description: The number of seconds to wait between retrying lock acquisition.

description: Configuration for Azure Blob Storage state backend.

description: The azure connection string to use for connecting to Azure Blob Storage.

description: Configuration for Google Cloud Storage state backend.

description: Path to a Google credentials file to use for authenticating to Google Cloud Storage.

description: Configuration for AWS S3 state backend.

description: AWS access key ID to use for authenticating to AWS S3.

description: AWS secret access key to use for authenticating to AWS S3.

description: S3 endpoint URL to use.

description: An array of environments (i.e. dev, stage, prod) with override configs for plugins based on the environment its run in.

$ref: #/$defs/environments

description: URL to remote manifest of Meltano plugins, used by meltano discover. Set to 'false' to disable.

description: An array of paths (relative to the project directory) of other Meltano config files to include in the configuration.

$ref: #/$defs/plugins/extractors

$ref: #/$defs/plugins/loaders

$ref: #/$defs/plugins/mappers

$ref: #/$defs/plugins/orchestrators

$ref: #/$defs/plugins/transformers

$ref: #/$defs/plugins/files

$ref: #/$defs/plugins/utilities

$ref: #/$defs/plugins/transforms

$ref: #/$defs/schedules

description: Scheduled ELT jobs, added using 'meltano schedule'

$ref: #/$defs/env

$ref: #/$defs/jobs

description: Jobs, added using 'meltano job'

description: The number of times to retry connecting to the Meltano database.

description: The time in seconds to wait between Meltano database connection attempts.

description: CLI related settings.

description: The path to the logging config, relative to the Meltano project root.

description: ELT related settings

description: The size of the ELT buffer in bytes.

description: Whether experimental features should be enabled.

description: A feature flag, which can be used to enable or disable particular Meltano features.

description: Whether to use Uvicorn rather than Gunicorn as the API server.

description: Whether the API includes scheduled jobs in listings.

description: Whether references to undefined environment variables cause Meltano to exit with an error.

description: Whether plugin locks are required to run a job.

description: The URL to the root of the Meltano Hub API.

description: The URL for Meltano Hub.

type: string boolean null

description: The value of the `Authorization` header when making requests to Meltano Hub. If null, false, or unset, no `Authorization` header is used.

description: Snowplow related settings.

description: Array of Snowplow collector endpoints.

description: A URL to which Snowplow events will be sent if telemetry is enabled.

description: Arbitrary annotations keyed by tool/vendor name - not processed by the core Meltano library or CLI

description: The name of the plugin.

description: A description of the plugin.

description: The type of the plugin.

enum: extractors loaders orchestrators transformers files utilities transforms mappers

description: The URL of the repository containing the source code for the plugin.

description: The URL of the repository containing the source code for a Meltano extension plugin that typically wraps some other tool, in which case the 'repo' property is used for the URL of the repository for that tool.

description: An existing plugin to inherit from.

description: The pip hosted package name or URL

description: The variant of the plugin.

description: The namespace of this plugin

description: Your plugin configuration, type 'meltano config <plugin> list' for details

description: A user friendly label describing the plugin

examples:
Stripe
Facebook Ads

description: An optional logo URL for this plugin

description: The python version to use for this plugin, specified as a path, or as the name of an executable to find within a directory in $PATH. If not specified, the top-level `python` setting will be used, or if it is not set, the python executable that was used to run Meltano will be used (within a separate virtual environment).

description: The plugin's executable name, as defined in setup.py (if a Python based plugin)

description: A URL to the documentation for this plugin

description: A set consisting of one valid combination of required setting names

description: A mapping of command names to either a string command, or an object containing info about the command.

description: Command arguments

description: Documentation displayed when listing commands

description: Override the plugin's executable for this command

description: Container specification for this command

description: Container image

description: Container command

examples: list test compile

description: Container entrypoint

description: Mapping of host to container ports

description: Array of volumes to mount during container execution

description: Mapping to environment variable to set inside the container. These take precedence over Meltano own runtime environment variables.

description: The command as a string.

description: A path to a catalog file (relative to the project directory) to be provided to the extractor when it is run in sync mode.

description: The name of the database schema extracted data should be loaded into.

description: An object containing Singer stream and property metadata

description: An object representing override rules for a Singer stream schema

description: A path to a state file (relative to the project directory) to be provided to the extractor when it is run as part of a pipeline using meltano elt.

description: An array of entity selection rules in the form '<entity|*>.<attribute|*>'

description: An array of entity selection filter rules that are applied to the extractor's discovered or provided catalog file when the extractor is run.

enum: properties catalog discover state about stream-maps activate-version batch test log-based schema-flattening

enum: about stream-maps activate-version batch soft-delete hard-delete datatype-failsafe record-flattening

description: The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.

description: The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.

description: An object containing dbt model variables

description: The name of the dbt package's internal dbt project: the value of name in dbt_project.yml.

description: Name of the invokable mappings and their associated configs.

description: The name of the setting

description: Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'

description: A user friendly label for the setting

description: The default value of this setting if not otherwise defined

description: A placeholder value for this setting

description: The type of value this setting contains

enum: oauth hidden password date_iso8601 file email integer options object array boolean string

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account

description: A phrase to provide additional information on this setting

description: A link to documentation on this setting

description: A protected setting cannot be changed from the UI

description: An alternative environment variable name to populate with this settings value in the plugin environment.

description: Use with `kind: object` to pre-process the keys in a particular way.

description: Use with `kind: object` to post-process the keys in a particular way.

description: The name of a Meltano-supported OAuth provider

description: A user friendly label for the option

description: The value of this option

required: name extractor loader transform interval start_date

description: The schedule's unique name

description: The name of a meltano job

description: The name of the extractor plugin

description: The name of the loader plugin

description: A UNIX cron expression to represent the frequency the scheduled job should execute

description: Describes if transforms should run, be skipped, or if only transforms should execute (skip extractors and loaders)

description: The date when the schedule should first execute

description: This jobs unique name

description: The name of the environment.

description: An object of environment specific configurations.

description: An object of environment specific plugin configurations.

description: A set of plugin requirements.

description: A single plugin requirement

description: The name of the required plugin

description: The variant of the required plugin

description: Mapping of environment variables for use in config.


resjson.json

$ref: #/definitions/resource

title: JSON schema for Windows resource files (.resjson)