schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
yarnrc.json
npmPublishAccess
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.
{"_package": "@yarnpkg/plugin-npm-cli", "type": "string", "enum": ["public", "restricted"]}
yarnrc.json
npmPublishRegistry
If not explicitly set, the value of `npmRegistryServer` will be used. Overridden by `publishConfig.registry`.
{"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "examples": ["https://npm.pkg.github.com"]}
yarnrc.json
npmRegistryServer
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`.
{"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "default": "https://registry.yarnpkg.com"}
yarnrc.json
packageExtensions
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 ...
{"_package": "@yarnpkg/core", "type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)(?:@(.+))$": {"type": "object", "properties": {"dependencies": {"type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)$": {"type": "string", "pattern": "^(.+)$", "examples": ["^4.15.0"]}}, "additionalProperties": f...
yarnrc.json
^(?:@([^/]+?)/)?([^/]+?)(?:@(.+))$
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.
{"type": "object", "properties": {"dependencies": {"type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)$": {"type": "string", "pattern": "^(.+)$", "examples": ["^4.15.0"]}}, "additionalProperties": false, "_exampleKeys": ["lodash"]}, "peerDependencies": {"type": "object", "patternProperties": {"^(?:@([^/]+...
yarnrc.json
pnpEnableEsmLoader
If true, Yarn will generate an experimental ESM loader (`.pnp.loader.mjs`) on top of the CJS one.
{"_package": "@yarnpkg/plugin-pnp", "type": "boolean", "default": false}
yarnrc.json
pnpEnableInlining
If false, Yarn will generate an additional `.pnp.data.json` file.
{"_package": "@yarnpkg/plugin-pnp", "type": "boolean", "default": true}
yarnrc.json
pnpFallbackMode
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.
{"_package": "@yarnpkg/plugin-pnp", "type": "string", "enum": ["none", "dependencies-only", "all"], "default": "dependencies-only"}
yarnrc.json
pnpIgnorePatterns
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.
{"_package": "@yarnpkg/plugin-pnp", "type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["./subdir/*"]}
yarnrc.json
pnpMode
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, hoist...
{"_package": "@yarnpkg/plugin-pnp", "enum": ["strict", "loose"], "type": "string", "default": "strict"}
yarnrc.json
pnpUnpluggedFolder
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.
{"_package": "@yarnpkg/plugin-pnp", "type": "string", "format": "uri-reference", "default": "./.yarn/unplugged"}
yarnrc.json
preferDeferredVersions
If true, deferred versioning by default when running the `yarn version` family of commands.
{"_package": "@yarnpkg/plugin-version", "type": "boolean", "default": false}
yarnrc.json
preferInteractive
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).
{"_package": "@yarnpkg/core", "type": "boolean", "default": false}
yarnrc.json
preferReuse
If true, `yarn add` will attempt to reuse the most common dependency range in other workspaces.
{"_package": "@yarnpkg/plugin-essentials", "type": "boolean", "default": false}
yarnrc.json
preferTruncatedLines
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.
{"_package": "@yarnpkg/core", "type": "boolean", "default": false}
yarnrc.json
cpu
See https://nodejs.org/docs/latest/api/process.html#processarch for the architectures supported by Node.js
{"type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["current", "x64", "ia32"]}
yarnrc.json
telemetryInterval
By default we only send one request per week, making it impossible for us to track your usage with a lower granularity.
{"_package": "@yarnpkg/core", "type": "number", "default": 7}
yarnrc.json
telemetryUserId
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 t...
{"_package": "@yarnpkg/core", "type": "string", "examples": ["yarnpkg/berry"]}
yarnrc.json
tsEnableAutoTypes
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.
{"_package": "@yarnpkg/plugin-typescript", "type": "boolean", "examples": [true]}
yarnrc.json
virtualFolder
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__`.
{"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "pattern": "^.*__virtual__$", "default": "./.yarn/__virtual__"}
yarnrc.json
yarnPath
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 pr...
{"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["./scripts/yarn-2.0.0-rc001.js"]}
pubspec.json
Dart Pubspec file
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"version": {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+(?:[+-]\\S+)?$"}, "versionConstraint": {"oneOf": [{"type": "string", "enum": ["any", ""]}, {}, {"type": "string", "examples": [">1.0.0 <2.3.0-beta", ">=1.0.0-pre.1 <=3.0.0"], "pattern": "^...
pubspec.json
versionConstraint
Version range of the package or SDK to use
{"oneOf": [{"type": "string", "enum": ["any", ""]}, {}, {"type": "string", "examples": [">1.0.0 <2.3.0-beta", ">=1.0.0-pre.1 <=3.0.0"], "pattern": "^(?:(?:>=|>|<=|<)\\d+\\.\\d+\\.\\d+(?:[+-]\\S+)?\\s*)+$"}, {"type": "string", "examples": ["^1.0.0"], "pattern": "^\\^\\d+\\.\\d+\\.\\d+(?:[+-]\\S+)?$"}]}
pubspec.json
versionConstraint
Allows any version of the package. This is not recommended for performance reasons
{"type": "string", "enum": ["any", ""]}
pubspec.json
dependency
Default dependency, matches any version of the package
{"type": "null"}
pubspec.json
sdk
The SDK which contains this package
{"type": "string"}
pubspec.json
hosted
URL of the package server hosting this package
{"type": "string", "format": "uri"}
pubspec.json
url
The package server hosting this package
{"type": "string", "format": "uri"}
pubspec.json
dependency
Git dependency
{"type": "object", "properties": {"git": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"url": {"type": "string"}, "path": {"type": "string"}, "ref": {"type": "string"}}}]}}, "required": ["git"], "additionalProperties": false}
pubspec.json
git
URI of the repository hosting this package
{"type": "string"}
pubspec.json
url
URI of the repository hosting this package
{"type": "string"}
pubspec.json
path
Path of this package relative to the Git repo's root
{"type": "string"}
pubspec.json
ref
The branch, tag, or anything else Git allows to identify a commit.
{"type": "string"}
pubspec.json
dependency
Path dependency
{"type": "object", "properties": {"path": {"type": "string"}}, "additionalProperties": false}
pubspec.json
name
The name of this package. The name is how other packages refer to yours, should you publish it.
{"type": "string"}
samtrc.json
extends
The name of the configuration file to extend from, used to determine the default rules to apply
{"anyOf": [{"type": "string"}, {"enum": ["recommended", "strict"]}]}
samtrc.json
rules
Configuration for linter rules for the current project
{"type": "array", "items": {"oneOf": [{"type": "object", "required": ["type"], "properties": {"type": {"const": "split-model-and-providers"}, "level": {}}, "additionalProperties": false}, {"type": "object", "required": ["type"], "properties": {"type": {"const": "naming-conventions"}, "level": {}, "record": {}, "recordF...
samtrc.json
items
Configure whether model types (e.g. record and service) must be in a separate file from their providers and consumers
{"type": "object", "required": ["type"], "properties": {"type": {"const": "split-model-and-providers"}, "level": {}}, "additionalProperties": false}
samtrc.json
items
Configure naming rules which apply to all types in the project
{"type": "object", "required": ["type"], "properties": {"type": {"const": "naming-conventions"}, "level": {}, "record": {}, "recordField": {}, "enum": {}, "enumValue": {}, "typeAlias": {}, "service": {}, "serviceOperation": {}, "serviceOperationParameter": {}, "provider": {}, "package": {}, "fileName": {}}, "additional...
swadl-schema-1.0.json
SWADL (Symphony Workflow Automation Definition Language) is a language to describe workflows on Symphony.
{"$schema": "http://json-schema.org/draft-04/schema#", "default": {}, "type": "object", "additionalProperties": false, "required": ["id", "activities"], "properties": {"id": {"type": "string", "pattern": "^[a-zA-Z]+[a-zA-Z0-9][^ ]*$", "default": "my-workflow", "maxLength": 100}, "properties": {"type": "object", "proper...
swadl-schema-1.0.json
id
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.
{"type": "string", "pattern": "^[a-zA-Z]+[a-zA-Z0-9][^ ]*$", "default": "my-workflow", "maxLength": 100}
swadl-schema-1.0.json
properties
Some metadata about the workflow
{"type": "object", "properties": {"publish": {"type": ["boolean", "string"], "default": true}}}
swadl-schema-1.0.json
publish
Should the workflow be published or not, true publish, false otherwise
{"type": ["boolean", "string"], "default": true}
swadl-schema-1.0.json
variables
Variables are accessible and editable within the entire workflow. A map of key: value entries is expected.
{"type": "object"}
swadl-schema-1.0.json
activities
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.
{"type": "array", "minLength": 1, "items": {"type": "object", "additionalProperties": false, "properties": {"create-room": {"x-intellij-html-description": "<html><p>Creates a new chatroom.\n</p><a href=\"https://developers.symphony.com/restapi/reference#create-room-v3\">https://developers.symphony.com/restapi/reference...
swadl-schema-1.0.json
create-room
Creates a new chatroom.
{"x-intellij-html-description": "<html><p>Creates a new chatroom.\n</p><a href=\"https://developers.symphony.com/restapi/reference#create-room-v3\">https://developers.symphony.com/restapi/reference#create-room-v3</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
update-room
Updates the attributes of an existing chat room.
{"x-intellij-html-description": "<html><p>Updates the attributes of an existing chat room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
add-room-member
Adds new members to an existing room.
{"x-intellij-html-description": "<html><p>Adds a new members to an existing room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#add-member\">https://developers.symphony.com/restapi/reference#add-member</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
remove-room-member
Removes members from an existing room.
{"x-intellij-html-description": "<html><p>Removes members from an existing room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#remove-member\">https://developers.symphony.com/restapi/reference#remove-member</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
promote-room-owner
Promotes user to owner of the chat room.
{"x-intellij-html-description": "<html><p>Promotes user to owner of the chat room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#promote-owner\">https://developers.symphony.com/restapi/reference#promote-owner</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
demote-room-owner
Demotes room owner to a participant in the chat room.
{"x-intellij-html-description": "<html><p>Demotes room owner to a participant in the chat room.</p><a href=\"https://developers.symphony.com/restapi/reference#demote-owner\">https://developers.symphony.com/restapi/reference#demote-owner</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
send-message
Posts a message to a stream.
{"x-intellij-html-description": "<html><p>Posts a message to a stream.</p><a href=\"https://developers.symphony.com/restapi/reference#create-message-v4\">https://developers.symphony.com/restapi/reference#create-message-v4</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
update-message
Updates an existing message into a stream.
{"x-intellij-html-description": "<html><p>Updates an existing message into a stream.</p><a href=\"https://developers.symphony.com/restapi/reference#update-message-v4\">https://developers.symphony.com/restapi/reference#update-message-v4</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
pin-message
Pin an existing message into the stream it belongs to.
{"x-intellij-html-description": "<html><p>Pin an existing message into the stream it belongs to.<a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a><a href=\"https://developers.symphony.com/restapi/v20.13/reference#update-im\">...
swadl-schema-1.0.json
unpin-message
Unpin any message (if present) from an existing stream.
{"x-intellij-html-description": "<html><p>Unpin any message (if present) from an existing stream.</p><a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a><a href=\"https://developers.symphony.com/restapi/v20.13/reference#update-...
swadl-schema-1.0.json
get-attachment
Gets one attachment and stores it locally.
{"x-intellij-html-description": "<html><p>Gets one attachment and stores it locally.</p><a href=\"https://developers.symphony.com/restapi/reference#attachment\">https://developers.symphony.com/restapi/reference#attachment</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
debug
Standard debug activity.
{"x-intellij-html-description": "<html><p>Standard debug activity.</p></html>", "type": "object", "properties": {"id": {"type": "string", "pattern": "^(?!variables$)([a-zA-Z][a-zA-Z0-9_]+)$"}, "on": {}, "if": {"type": "string"}, "else": {"type": "object"}, "object": {"type": ["object", "string"]}}, "required": ["object...
swadl-schema-1.0.json
id
Activity's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.
{"type": "string", "pattern": "^(?!variables$)([a-zA-Z][a-zA-Z0-9_]+)$"}
swadl-schema-1.0.json
if
Conditional execution of the activity based on a boolean expression.
{"type": "string"}
swadl-schema-1.0.json
else
Default execution of the activity when if conditions are used for previous activities.
{"type": "object"}
swadl-schema-1.0.json
execute-script
Executes a Groovy script.
{"x-intellij-html-description": "<html><p>Executes a Groovy script.</p></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
execute-request
Executes an HTTP request.
{"allOf": [{}, {}]}
swadl-schema-1.0.json
create-user
Creates a new end user.
{"x-intellij-html-description": "<html><p>Creates a new end user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-user-v2\">https://developers.symphony.com/restapi/reference#create-user-v2</a></html>", "allOf": [{}, {"required": ["email", "username", "firstname", "lastname", "display-name"]}]}
swadl-schema-1.0.json
update-user
Updates an existing end user.
{"x-intellij-html-description": "<html><p>Updates an existing end user.</p><a href=\"https://developers.symphony.com/restapi/reference#update-user-v2\">https://developers.symphony.com/restapi/reference#update-user-v2</a></html>", "allOf": [{}, {}, {"type": "object", "properties": {"user-id": {}}, "required": ["user-id"...
swadl-schema-1.0.json
create-system-user
Creates a new service user.
{"x-intellij-html-description": "<html><p>Creates a new service user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-user-v2\">https://developers.symphony.com/restapi/reference#create-user-v2</a></html>", "allOf": [{}, {"required": ["email", "username", "display-name"]}]}
swadl-schema-1.0.json
update-system-user
Updates an existing service user.
{"x-intellij-html-description": "<html><p>Updates an existing service user.</p><a href=\"https://developers.symphony.com/restapi/reference#update-user-v2\">https://developers.symphony.com/restapi/reference#update-user-v2</a></html>", "allOf": [{}, {}, {"type": "object", "properties": {"user-id": {}}, "required": ["user...
swadl-schema-1.0.json
add-user-role
Adds roles to user accounts.
{"x-intellij-html-description": "<html><p>Adds a role or optional entitleable action to a user\u2019s account.</p><a href=\"https://developers.symphony.com/restapi/reference#add-role\">https://developers.symphony.com/restapi/reference#add-role</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
remove-user-role
Removes roles from user accounts.
{"x-intellij-html-description": "<html><p>Removes a role or optional entitleable action from a user\u2019s account.</p><a href=\"https://developers.symphony.com/restapi/reference#remove-role\">https://developers.symphony.com/restapi/reference#remove-role</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-user
Returns details for a particular user.
{"x-intellij-html-description": "<html><p>Returns details for a particular user.</p><a href=\"https://developers.symphony.com/restapi/reference#get-user-v2\">https://developers.symphony.com/restapi/reference#get-user-v2</a></html>", "type": "object", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-users
Returns a list of users ID, including user metadata.
{"x-intellij-html-description": "<html><p>Returns a list of users ID, including user metadata.</p><a href=\"https://developers.symphony.com/restapi/reference#users-lookup-v3\">https://developers.symphony.com/restapi/reference#users-lookup-v3</a></html>", "type": "object", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-stream
Returns information about a particular stream.
{"type": "object", "x-intellij-html-description": "<htmL><p>Returns information about a particular stream.</p><a href=\"https://developers.symphony.com/restapi/reference#stream-info-v2\">https://developers.symphony.com/restapi/reference#stream-info-v2</a></html", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-room
Returns information about a particular chat room.
{"type": "object", "x-intellij-html-description": "<html><p>Returns information about a particular chat room.</p><a href=\"https://developers.symphony.com/restapi/reference#room-info-v3\">https://developers.symphony.com/restapi/reference#room-info-v3</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-message
Returns a message found by id.
{"type": "object", "x-intellij-html-description": "<html><p>Returns a message found by id.</p><a href=\"https://developers.symphony.com/restapi/reference#get-message-v1\">https://developers.symphony.com/restapi/reference#get-message-v1</html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-stream-members
Returns a list of all the current members of a stream (IM, MIM, or chatroom).
{"type": "object", "x-intellij-html-description": "<html><p>Returns a list of all the current members of a stream (IM, MIM, or chatroom).</p><a href=\"https://developers.symphony.com/restapi/reference#stream-members\">https://developers.symphony.com/restapi/reference#stream-members</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-room-members
Lists the current members of an existing room.
{"type": "object", "x-intellij-html-description": "<html><p>Lists the current members of an existing room.</p><a href=\"https://developers.symphony.com/restapi/reference#room-members\">https://developers.symphony.com/restapi/reference#room-members</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-user-streams
Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).
{"type": "object", "x-intellij-html-description": "<html><p>Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).</p><a href=\"https://developers.symphony.com/restapi/reference#list-user-streams\">https://developers.symphony.com/restapi/refer...
swadl-schema-1.0.json
get-streams
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).
{"type": "object", "x-intellij-html-description": "<html><p>Returns a list of all the streams (IMs, MIMs, and chatrooms) for the calling user's company, sorted by creation date (ascending \u2013 oldest to newest).</p><a href\"https://developers.symphony.com/restapi/reference#list-streams-for-enterprise-v2\">https://dev...
swadl-schema-1.0.json
get-connection
Get one connection status.
{"type": "object", "x-intellij-html-description": "<html><p>Get one connection status.</p><a href=\"https://developers.symphony.com/restapi/reference#get-connection\">https://developers.symphony.com/restapi/reference#get-connection</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
create-connection
Send a connection request to another user.
{"type": "object", "x-intellij-html-description": "<html><p>Send a connection request to another user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-connection\">https://developers.symphony.com/restapi/reference#create-connection</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
accept-connection
Accept the connection request for a requesting user.
{"type": "object", "x-intellij-html-description": "<html><p>Accept the connection request for a requesting user.</p><a href=\"https://developers.symphony.com/restapi/reference#accepted-connection\">https://developers.symphony.com/restapi/reference#accepted-connection</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
reject-connection
Reject the connection request from a requesting user.
{"type": "object", "x-intellij-html-description": "<html><p>Reject the connection request from a requesting user.</p><a href=\"https://developers.symphony.com/restapi/reference#reject-connection\">https://developers.symphony.com/restapi/reference#reject-connection</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
remove-connection
Remove a connection with a user.
{"type": "object", "x-intellij-html-description": "<html><p>Remove a connection with a user.</p><a href=\"https://developers.symphony.com/restapi/reference#remove-connection\">https://developers.symphony.com/restapi/reference#remove-connection</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-rooms
Search for rooms, querying name, description, and specified keywords.
{"type": "object", "x-intellij-html-description": "<html><p>Search for rooms, querying name, description, and specified keywords.</p><a href=\"https://developers.symphony.com/restapi/reference#search-rooms-v3\">https://developers.symphony.com/restapi/reference#search-rooms-v3</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-messages
Get messages from an existing stream (IM, MIM, or chatroom). Additionally returns any attachments associated with the message.
{"type": "object", "x-intellij-html-description": "<html><p>Get messages from an existing stream (IM, MIM, or chatroom).\nAdditionally returns any attachments associated with the message.</p><a href=\"https://developers.symphony.com/restapi/reference#messages-v4\">https://developers.symphony.com/restapi/reference#messa...
swadl-schema-1.0.json
get-connections
Get one or multiple connections statuses
{"type": "object", "x-intellij-html-description": "<html><p>Get one or multiple connections statuses</p><a href=\"https://developers.symphony.com/restapi/reference#list-connections\">https://developers.symphony.com/restapi/reference#list-connections</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
create-group
Create a group (distribution list)
{"type": "object", "x-intellij-html-description": "<html><p>Create a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/insertgroup\">https://developers.symphony.com/restapi/reference/insertgroup</a></html>", "allOf": [{}, {}], "required": ["name", "owner", "members", "profile"]}
swadl-schema-1.0.json
update-group
Update a group (distribution list)
{"type": "object", "x-intellij-html-description": "<html><p>Update a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/updategroup\">https://developers.symphony.com/restapi/reference/updategroup</a></html>", "allOf": [{}, {}, {"type": "object"}]}
swadl-schema-1.0.json
get-group
Retrieve a group (distribution list)
{"type": "object", "x-intellij-html-description": "<html><p>Retrieve a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/getgroup\">https://developers.symphony.com/restapi/reference/getgroup</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
get-groups
Retrieve groups of specified type (distribution list)
{"type": "object", "x-intellij-html-description": "<html><p>Retrieve groups of specified type (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/listgroups\">https://developers.symphony.com/restapi/reference/listgroups</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
add-group-member
Add members to a group (distribution list)
{"type": "object", "x-intellij-html-description": "<html><p>Add members to a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/addmembertogroup\">https://developers.symphony.com/restapi/reference/addmembertogroup</a></html>", "allOf": [{}, {}]}
swadl-schema-1.0.json
local
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.
{"type": ["boolean", "string"], "default": false}
swadl-schema-1.0.json
active
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.
{"type": ["boolean", "string"]}
swadl-schema-1.0.json
on
Events that can trigger the activity execution.
{"x-intellij-html-description": "<html><p>Events that can trigger the activity execution.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events\">List of real-time events: https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events</a></html>"...
swadl-schema-1.0.json
timeout
Timeout while waiting for form-replied events, expressed as an ISO 8601 duration. Default value is 24 hours.
{"type": "string", "pattern": "^P(?!$)(\\d+(?:\\.\\d+)?Y)?(\\d+(?:\\.\\d+)?M)?(\\d+(?:\\.\\d+)?W)?(\\d+(?:\\.\\d+)?D)?(T(?=\\d)(\\d+(?:\\.\\d+)?H)?(\\d+(?:\\.\\d+)?M)?(\\d+(?:\\.\\d+)?S)?)?$"}
swadl-schema-1.0.json
form-replied
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.
{"x-intellij-html-description": "<html><p>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 <a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/symphony-eleme...
swadl-schema-1.0.json
request-received
Generated when an HTTP request is received in order to trigger a workflow.
{}
swadl-schema-1.0.json
message-received
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.
{"x-intellij-html-description": "<html><p>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.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#message-sent\">https://docs....
swadl-schema-1.0.json
message-suppressed
Generated when messages are suppressed.
{"x-intellij-html-description": "<html><p>Generated when messages are suppressed.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#messages-suppressed\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#messages-suppressed</a></...
swadl-schema-1.0.json
post-shared
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": "<html><p>Generated when either:<li>The workflow bot shares a wall post written by another user.</li><li>Another user shares a wall post written by the workflow bot.</li></p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#shared-wall-pos...
swadl-schema-1.0.json
im-created
Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.
{"x-intellij-html-description": "<html><p>Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#im-mim-created\">https://docs.developers.symphon...