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

type: array boolean object string

type: boolean integer null number object string


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

type: object array


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.

type: object

type: string

format: uri-reference

enum: required-only match-spec always auto

default: auto

type: array

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

enum: throw update ignore reset

default: throw

type: number

type: number string

default: mixed

default: node

default: npm:

type: boolean

titke: Define whether to run postinstall scripts or not.

format: uri

default: yarnpkg

type: string number boolean

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

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

enum: info warning error discard

level: discard

level: error

enum: workspaces dependencies none

default: classic

enum: pnp pnpm node-modules

default: pnp

enum: junctions symlinks

enum: public restricted


key: cacheFolder

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.


key: cacheMigrationMode

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).


key: changesetBaseRefs

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


key: changesetIgnorePatterns

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`).


key: checksumBehavior

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.


key: cloneConcurrency

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


key: compressionLevel

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.


key: constraintsPath

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


key: defaultLanguageName

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


key: defaultProtocol


key: defaultSemverRangePrefix

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


key: enableColors

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


key: enableGlobalCache

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


key: enableHyperlinks


key: enableImmutableCache

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.


key: enableImmutableInstalls

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.


key: enableInlineBuilds

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.


key: enableInlineHunks

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


key: enableMessageNames

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


key: enableMirror

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.


key: enableNetwork

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.


key: enableProgressBars

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


key: enableScripts

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`.


key: enableStrictSsl

description: If false, SSL certificate errors will be ignored


key: enableTelemetry

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.


key: enableTimers

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.


key: enableTransparentWorkspaces

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).


key: globalFolder

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


key: httpProxy

description: Only HTTP proxies are supported at the moment.


key: httpsProxy


key: ignorePath

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


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


key: installStatePath

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).


key: logFilters

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.

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

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


key: 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.


key: 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`.


key: networkConcurrency

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.


key: nmHoistingLimits

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.


key: nmSelfReferences

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.


key: nmMode

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`.


key: nodeLinker

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.


key: winLinkType

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.


key: npmAlwaysAuth

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.


key: npmAuditRegistry

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


key: npmAuthIdent

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


key: npmAuthToken

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.


key: npmPublishAccess

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.


key: npmPublishRegistry

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


key: npmRegistryServer

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`.


key: packageExtensions

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.


key: pnpEnableEsmLoader

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


key: pnpEnableInlining

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


key: pnpFallbackMode

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.

enum: none dependencies-only all

default: dependencies-only


key: pnpIgnorePatterns

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.


key: pnpMode

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.

enum: strict loose

default: strict


key: pnpUnpluggedFolder

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.


key: preferDeferredVersions

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


key: preferInteractive

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).


key: preferReuse

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


key: preferTruncatedLines

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.


key: cpu

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


key: telemetryInterval

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


key: telemetryUserId

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).


key: tsEnableAutoTypes

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.


key: virtualFolder

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__`.


key: yarnPath

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.


description: Dart Pubspec file


key: versionConstraint

description: Version range of the package or SDK to use


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


key: dependency

description: Default dependency, matches any version of the package


key: sdk

description: The SDK which contains this package


key: hosted

description: URL of the package server hosting this package


key: url

description: The package server hosting this package


description: Git dependency


key: git

description: URI of the repository hosting this package


key: path

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


key: ref

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


description: Path dependency


key: name

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


key: extends

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

enum: recommended strict


key: rules

description: Configuration for linter rules for the current project

const: split-model-and-providers

const: naming-conventions


key: items

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


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


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

required: id activities

default: my-workflow

type: boolean string

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type: object string

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

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

required: email username firstname lastname display-name

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

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

required: email username display-name

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

required: name owner members profile

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

x-intellij-html-description: Used to receive all listed events.

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

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.

x-intellij-html-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.

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.

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.

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

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

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

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

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


key: id

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.


key: properties

description: Some metadata about the workflow


key: publish

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


key: variables

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


key: activities

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


key: create-room

description: Creates a new chatroom.

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

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


key: update-room

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

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


key: add-room-member

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


key: remove-room-member

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


key: promote-room-owner

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

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


key: demote-room-owner

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


key: send-message

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


key: update-message

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


key: pin-message

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


key: unpin-message

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


key: get-attachment

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


key: debug

description: Standard debug activity.

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


key: id

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


key: if

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


key: else

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


key: execute-script

description: Executes a Groovy script.

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


key: execute-request

description: Executes an HTTP request.


key: create-user

description: Creates a new end user.

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


key: update-user

description: Updates an existing end user.

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


key: create-system-user

description: Creates a new service user.

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


key: update-system-user

description: Updates an existing service user.

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


key: add-user-role

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


key: remove-user-role

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


key: get-user

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


key: get-users

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


key: get-stream

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


key: get-room

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


key: get-message

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


key: get-stream-members

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


key: get-room-members

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


key: get-user-streams

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


key: get-streams

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


key: get-connection

description: Get one connection status.

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


key: create-connection

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


key: accept-connection

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


key: reject-connection

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


key: remove-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


key: get-rooms

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


key: get-messages

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


key: get-connections

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


key: create-group

description: Create a group (distribution list)

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


key: update-group

description: Update a group (distribution list)

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


key: get-group

description: Retrieve a group (distribution list)

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


key: get-groups

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


key: add-group-member

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


key: local

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.


key: active

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.


key: on

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


key: timeout

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


key: form-replied

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


key: request-received

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


key: message-received

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


key: message-suppressed

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


key: post-shared

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


key: im-created

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


key: room-created

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


key: room-updated

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


key: room-deactivated

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


key: room-reactivated

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


key: room-member-promoted-to-owner

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


key: room-member-demoted-from-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


key: user-joined-room

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


key: user-left-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


key: user-requested-join-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


key: connection-requested

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


key: connection-accepted

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


key: activity-expired

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


key: activity-failed

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


key: activity-completed

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


key: all-of

description: Used to receive all listed events.

x-intellij-html-description: Used to receive all listed events.


key: one-of

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


key: timer-fired

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.


key: repeat

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


key: at

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


key: form-id

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


key: exclusive

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


key: content

description: Message content to listen to.


key: requires-bot-mention

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


key: id

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


key: token

description: Token to authorize incoming http requests.


key: activity-id

description: The expiring activity triggering this event.


description: The failing activity triggering this event.


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


key: basic-activity-inner

description: Inner property having common properties for every activity.


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


key: if

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


key: else

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


key: room-name

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.


key: room-description

description: Room's description.


key: keywords

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


key: members-can-invite

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


key: discoverable

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.


key: public

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.


key: read-only

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.


key: copy-protected

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.


key: cross-pod

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


key: view-history

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


key: multilateral-room

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


key: active

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


key: obo

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


key: stream-id

description: Stream's id to update.


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


key: user-ids

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.


key: to

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


key: data

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


key: attachments

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


key: silent

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


key: script

description: Script to execute (only Groovy is supported)

x-intellij-language-injection: Groovy


key: url

description: Contains the host and the path to be targeted


key: encode-query-params

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


key: method

description: HTTP method to perform

default: GET

enum: GET POST PUT DELETE PATCH HEAD OPTIONS


key: body

description: HTTP request body


description: HTTP request body


key: headers

description: HTTP request headers


key: email

description: Email address, must be unique


key: phoneNumber

description: The user's work phone number.


key: business

description: Business information

enum: EMEA NA APAC LATAM

enum: BAU Escalation

enum:
Securities
Fixed Income
Equities


key: company-name

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


key: department

description: The user's department.


key: division

description: The user's division.


key: title

description: The user's title.


key: location

description: The user's location.


key: job-function

description: The user's job function.


key: asset-classes

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


key: industries

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


key: functions

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


key: market-coverages

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


key: responsibilities

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


key: instruments

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


description: Email address, must be unique.


key: firstname

description: User's first name.


key: lastname

description: User's last name.


key: username

description: Unique identifier for the user.


key: display-name

description: User's display name.


key: recommended-language

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

default: en-US


key: contact

description: Contact information


key: work-phone-number

description: User's work phone number.


key: mobile-phone-number

description: User's mobile phone number.


key: two-factor-auth-number

description: User's two factor auth number.


key: sms-number

description: User's sms phone number.


key: business

description: User's business information.


key: password

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.

required: hashed-password hashed-salt


key: hashed-password

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


key: hashed-salt

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


key: hashed-km-password

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


key: hashed-km-salt

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


key: roles

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


key: entitlements

description: User entitlements.


key: status

description: User status: ENABLED or DISABLED.

enum: ENABLED DISABLED


key: email

description: Email address, must be unique


key: username

description: User's username.


key: display-name

description: User's display name.


key: keys

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


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


key: action

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.

enum: SAVE EXTEND REVOKE


key: key

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


key: expiration

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


key: entitlements-inner

description: Feature entitlements to configure for the user.


key: postReadEnabled

description: Allows the user to read wall posts.


key: postWriteEnabled

description: Allows the user to write wall posts.


key: delegatesEnabled

description: Allows the user to have delegates.


key: isExternalIMEnabled

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


key: canShareFilesExternally

description: Allows the user to share files externally.


key: canCreatePublicRoom

description: Allows the user to create internal public rooms.


key: canUpdateAvatar

description: Allows the user to edit profile picture.


key: isExternalRoomEnabled

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


key: canCreatePushedSignals

description: Allows the user to create push signals.


key: canUseCompactMode

description: Enables Lite Mode.


key: mustBeRecorded

description: Must be recorded in meetings.


key: sendFilesEnabled

description: Allows the user to send files internally.


key: canUseInternalAudio

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


key: canUseInternalVideo

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


key: canProjectInternalScreenShare

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


key: canViewInternalScreenShare

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


key: canCreateMultiLateralRoom

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


key: canJoinMultiLateralRoom

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


key: canUseFirehose

description: Allows the user to use Firehose.


key: canUseInternalAudioMobile

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


key: canUseInternalVideoMobile

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


key: canProjectInternalScreenShareMobile

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


key: canViewInternalScreenShareMobile

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


key: canManageSignalSubscription

description: Allows the user to manage signal subscriptions.


key: canCreateDatahose

description: Can create datahose feeds.


key: canIntegrateEmail

description: Can integrate email service.


key: canReadDatahose

description: Can read from datahose feeds.


key: canSuppressMessage

description: Can suppress own messages.


description: Can switch to Client 2.0 experience.


key: canUpdateRoomHistoryProperty

description: Can Toggle Room's Share History Property.


key: canUseEncryptAPI

description: Allow user to use Agent Encrypt endpoints.


key: enableSwiftSearch

description: Can Use Swift Search.


key: sdaDevtoolsEnabled

description: Enable Developer Tools for SDA.


key: sdaPermissionsFullScreen

description: Enable Full screen access on SDA.


key: sdaPermissionsGeoLocation

description: Enable location access on SDA.


key: sdaPermissionsMedia

description: Enable Media access on SDA.


key: sdaPermissionsMidiSysex

description: Enable access to MIDI Sysex on SDA.


key: sdaPermissionsNotifications

description: Allow notifications on SDA.


key: sdaPermissionsOpenExternalApp

description: Allow Opening External Apps from SDA.


key: sdaPermissionsPointerLock

description: Enable Pointer Lock on SDA.


key: roles-inner

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


key: user-ids

description: Users to add or remove roles from.

type: string integer


key: emails

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.


key: usernames

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.


key: local

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.


key: active

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.


key: obo

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


key: stream-id

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


key: types

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.

enum: IM MIM ROOM POST


key: include-inactive-streams

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.


key: message-id

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.

enum: IM MIM ROOM


key: scope

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.

enum: INTERNAL EXTERNAL


key: origin

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.


key: privacy

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.

enum: PRIVATE PUBLIC


key: status

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

enum: ACTIVE INACTIVE


key: start-date

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.


key: end-date

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.


key: query

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


key: labels

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.


key: private

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.


key: creator-id

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

type: string number


key: owner-id

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


key: member-id

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


key: sort-order

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

enum: BASIC RELEVANCE


key: obo

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


key: stream-id

description: Stream identifier.


key: since

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


key: user-ids

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


key: type

description: Group type identifier (for instance SDL).


key: name

description: Group's name.


key: sub-type

description: The type of the company new groupType.

enum: COMMUNITY CHANNEL


key: referrer

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


key: id

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


description: Owner type. Only TENANT supported now.

default: TENANT

enum: TENANT PLATFORM USER


key: user-id

description: Member's user id.


key: tenant-id

description: Member's tenant id.


key: display-name

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


key: company-name

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


key: asset-classes

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

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


key: industries

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

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


key: functions

description: The group'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


key: market-coverages

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


key: responsibilities

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


key: instruments

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


key: status

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

enum: ACTIVE DELETED


key: e-tag

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


key: image-path

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


key: type

description: Group type id.

default: SDL


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


key: before

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.


key: after

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


key: limit

description: Numbers of items to return.


key: group-id

description: Group's unique identifier.


key: obo-inner

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


key: content-inner

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.


key: template

description: Inline template message content in string.


key: template-path

description: External message template file path.


key: skip

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

type: integer string


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


key: message-id-inner

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


key: stream-id-inner

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


key: stream-id

description: Stream id to sent the message to.


key: stream-ids

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


key: user-ids-inner

description: User identifiers list.


key: user-ids

description: List of user ids.


key: user-id

description: User id.


key: message-id

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


key: attachment-id

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.


key: content-path

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


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

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

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


key: name

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


description: kas, a setup tool for bitbake based projects

type: integer

required: repo file

enum: openembedded oe isar


description: a schema for auto api cases

default: sql


description: CityJSON specifications v1.1.3

format: email

enum: individual organization

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

required: surfaces values

required: type lod boundaries

required: type template boundaries transformationMatrix

required: type transform version CityObjects vertices


key: role

description: from ISO 19115 codelist


key: parents

description: the IDs of the parents


key: children

description: the IDs of children


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


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.

required: hash url

required: id curations

required: value algorithm


key: exclude

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


key: always-semicolon

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


key: block-indent

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


key: color-case

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


key: color-shorthand

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


key: element-case

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


key: eof-newline

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


key: leading-zero

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


key: quotes

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


key: remove-empty-rulesets

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


key: space-after-colon

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


key: space-after-combinator

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


key: space-after-opening-brace

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


key: space-after-selector-delimiter

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


key: space-after-closing-brace

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


key: space-before-colon

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


key: space-before-combinator

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


key: space-before-opening-brace

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


key: space-before-selector-delimiter

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


key: space-between-declarations

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


key: strip-spaces

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


key: unitless-zero

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


key: vendor-prefix-align

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


key: sort-order

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


key: sort-order-fallback

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


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


Schema that describes the structure of a resource model document.


key: props

description: Which prop declaration method to use

enum: ts jsdoc prop-types none


key: children

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


key: typescript

description: Wether to use Typescript


key: flat

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


key: styling

description: Which styling solution to use

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


key: stylingModule

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


key: importReact

description: Whether to import React


key: overwrite

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


key: postCommand

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


key: baseDir

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


key: destination

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


key: allowOutsideBase

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


key: exportType

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

enum: named default


key: declaration

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

enum: const function


key: tsPropsDeclaration

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

enum: interface type


key: memo

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


key: separateIndex

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


key: reactNative

description: Whether to generate React Native components


key: debug

description: Whether to log additional debug information


key: $schema

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


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

default: systemdb

type: string boolean null

enum: extractors loaders orchestrators transformers files utilities transforms mappers

examples:
Stripe
Facebook Ads

examples: list test compile

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

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

required: name extractor loader transform interval start_date


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


key: python

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.


key: uri

description: The URI pointing to the backend to use.


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.


key: azure

description: Configuration for Azure Blob Storage state backend.


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


key: gcs

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.


key: environments

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


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.


key: schedules

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


key: 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.


key: cli

description: CLI related settings.


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


key: elt

description: ELT related settings


description: The size of the ELT buffer in bytes.


key: experimental

description: Whether experimental features should be enabled.


key: ff

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.


The URL to the root of the Meltano Hub API.


description: The URL for Meltano Hub.


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


key: snowplow

description: Snowplow related settings.


description: Array of Snowplow collector endpoints.


key: items

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


key: annotations

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


key: name

description: The name of the plugin.


key: description

description: A description of the plugin.


description: The type of the plugin.


key: repo

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


key: variant

description: The variant of the plugin.


key: namespace

description: The namespace of this plugin


key: config

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


key: label

description: A user friendly label describing the plugin


description: An optional logo URL for this plugin


key: python

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).


key: executable

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


key: docs

description: A URL to the documentation for this plugin


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


key: commands

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


key: args

description: Command arguments


description: Documentation displayed when listing commands


description: Override the plugin's executable for this command


description: Container specification for this command


key: image

description: Container image


key: command

description: Container command


key: entrypoint

description: Container entrypoint


key: ports

description: Mapping of host to container ports


key: volumes

description: Array of volumes to mount during container execution


key: env

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


key: additionalProperties

description: The command as a string.


key: catalog

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.


key: metadata

description: An object containing Singer stream and property metadata


key: schema

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


key: state

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.


key: select

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.


key: extractors


key: loaders


key: dialect

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.


key: vars

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.


key: mappings

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

required: config name


key: name

description: The name of the setting


key: aliases

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


key: label

description: A user friendly label for the setting


key: value

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


key: placeholder

description: A placeholder value for this setting


key: kind

description: The type of value this setting contains


key: description

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account


key: tooltip

description: A phrase to provide additional information on this setting


key: documentation

description: A link to documentation on this setting


key: protected

description: A protected setting cannot be changed from the UI


key: env

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


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


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


key: provider

description: The name of a Meltano-supported OAuth provider


description: A user friendly label for the option


description: The value of this option


key: schedules

required: name job interval

default: skip

enum: run skip only


description: The schedule's unique name


key: job

description: The name of a meltano job


key: extractor

description: The name of the extractor plugin


key: loader

description: The name of the loader plugin


key: interval

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


key: transform

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


key: jobs

required: name tasks


key: name

description: This jobs unique name


description: The name of the environment.


key: config

description: An object of environment specific configurations.


key: plugins

description: An object of environment specific plugin configurations.


key: requires

description: A set of plugin requirements.


description: A single plugin requirement


description: The name of the required plugin


key: variant

description: The variant of the required plugin


description: Mapping of environment variables for use in config.


key: Description

description: Template description


key: private

description: A boolean specifying whether the component is private, defaulting to  false.


description: A public component MUST have a 'name'. This is what will be passed to  require().


key: repo

description: The public component MUST have a 'repository' property, this is registry end-point consisting of  <username>/<project> , for example 'visionmedia/page.js' or 'component/dialog'.


key: description

description: The component SHOULD have a 'description' property. This helps people find and understand your component.


key: version

description: The public component MUST include a version, allowing other scripts to depend on specific releases of the component.