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

required: id activities

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

default: my-workflow

description: Some metadata about the workflow

type: boolean string

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

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

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

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

description: Creates a new chatroom.

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

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

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

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

description: Updates the attributes of an existing chat room.

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

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

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

description: Adds new members to an existing room.

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

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

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

description: Removes members from an existing room.

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

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

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

description: Promotes user to owner of the chat room.

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

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

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

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

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

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

description: Posts a message to a stream.

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

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

description: Updates an existing message into a stream.

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

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

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

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

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

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

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

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

description: Gets one attachment and stores it locally.

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

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

description: Standard debug activity.

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

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

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

$ref: #/definitions/on

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

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

type: object string

description: Executes a Groovy script.

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

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

description: Executes an HTTP request.

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

description: Creates a new end user.

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

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

required: email username firstname lastname display-name

description: Updates an existing end user.

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

$ref: #/definitions/user-id

description: Creates a new service user.

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

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

required: email username display-name

description: Updates an existing service user.

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

description: Adds roles to user accounts.

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

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

description: Removes roles from user accounts.

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

description: Returns details for a particular user.

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

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

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

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

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

description: Returns information about a particular stream.

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

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

description: Returns information about a particular chat room.

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

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

description: Returns a message found by id.

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

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

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

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

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

description: Lists the current members of an existing room.

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

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

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

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

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

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

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

description: Get one connection status.

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

$ref: #/definitions/connection-inner

description: Send a connection request to another user.

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

description: Accept the connection request for a requesting user.

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

description: Reject the connection request from a requesting user.

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

description: Remove a connection with a user.

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

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

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

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

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

description: Get one or multiple connections statuses

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

description: Create a group (distribution list)

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

description: Update a group (distribution list)

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

description: Retrieve a group (distribution list)

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

description: Retrieve groups of specified type (distribution list)

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

description: Add members to a group (distribution list)

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

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

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

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

description: Events that can trigger the activity execution.

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

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

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

title: object

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

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

description: Generated when messages are suppressed.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sent to the workflow bot by another user.

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

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

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

Sent by another user and accepted by the workflow bot.

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

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

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

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

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

description: Used to receive all listed events.

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

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

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

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

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

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

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

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

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

description: Message content to listen to.

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

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

description: Token to authorize incoming http requests.

description: The expiring activity triggering this event.

description: The failing activity triggering this event.

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

description: Inner property having common properties for every activity.

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

description: Room's description.

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Stream's id to update.

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

description: User ids to add to the room.

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

description: User ids to remove from the room.

description: Stream id where to promote user.

description: User ids to promote in the room.

description: Stream id where to demote user.

description: User ids to demote in the room.

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

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

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

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

description: Script to execute (only Groovy is supported)

description: Contains the host and the path to be targeted

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

description: HTTP method to perform

description: HTTP request body

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

description: HTTP request body

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

description: HTTP request headers

description: Email address, must be unique

description: The user's work phone number.

description: Business information

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

description: The user's department.

description: The user's division.

description: The user's title.

description: The user's location.

description: The user's job function.

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

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

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

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

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

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

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

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

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

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

description: Email address, must be unique.

description: User's first name.

description: User's last name.

description: Unique identifier for the user.

description: User's display name.

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

description: Contact information

description: User's work phone number.

description: User's mobile phone number.

description: User's two factor auth number.

description: User's sms phone number.

description: User's business information.

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

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

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

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

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

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

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

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

description: User entitlements.

description: User status: ENABLED or DISABLED.

description: Email address, must be unique

description: User's username.

description: User's display name.

description: User's business information.

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

description: User entitlements.

description: User status: ENABLED or DISABLED.

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

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

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

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

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

description: Feature entitlements to configure for the user.

description: Allows the user to read wall posts.

description: Allows the user to write wall posts.

description: Allows the user to have delegates.

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

description: Allows the user to share files externally.

description: Allows the user to create internal public rooms.

description: Allows the user to edit profile picture.

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

description: Allows the user to create push signals.

description: Enables Lite Mode.

description: Must be recorded in meetings.

description: Allows the user to send files internally.

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

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

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

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

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

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

description: Allows the user to use Firehose.

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

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

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

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

description: Allows the user to manage signal subscriptions.

description: Can create datahose feeds.

description: Can integrate email service.

description: Can read from datahose feeds.

description: Can suppress own messages.

description: Can switch to Client 2.0 experience.

description: Can Toggle Room's Share History Property.

description: Allow user to use Agent Encrypt endpoints.

description: Can Use Swift Search.

description: Enable Developer Tools for SDA.

description: Enable Full screen access on SDA.

description: Enable location access on SDA.

description: Enable Media access on SDA.

description: Enable access to MIDI Sysex on SDA.

description: Allow notifications on SDA.

description: Allow Opening External Apps from SDA.

description: Enable Pointer Lock on SDA.

description: Users to add or remove roles from.

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

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

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

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

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

description: The message identifier.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Stream identifier.

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

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

description: Group type identifier (for instance SDL).

description: Group's name.

description: The type of the company new groupType.

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

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

description: Owner type. Only TENANT supported now.

description: Member's user id.

description: Member's tenant id.

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

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

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

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

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

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

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

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

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

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

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

description: Group type id.

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

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

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

description: Numbers of items to return.

description: Group's unique identifier.

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

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

description: Inline template message content in string.

description: External message template file path.

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

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

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

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

description: Stream id to sent the message to.

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

description: User identifiers list.

description: List of user ids.

description: User id.

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

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

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


title: ui5-workspace.yaml

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

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

type: object

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

$ref: #/definitions/metadata

$ref: #/definitions/dependencyManagement

type: string

title: Workspace Name

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

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

type: array


servicehub.config.schema.json

description: Specifies the location of the controller executable and activation parameters.

description: Array of environment variable names. These variables are mixed-up into hash that determines the location service pipe name. The order is significant.

description: An object with properties like "environment variable name": "value" that describes what environment variables to set for the Hub Controller.

description: The value of the environment variable to set.

description: The path to the directory immediately under which are folders that contain *.servicehub.host.json files.

description: The path to the directory immediately under which are folders that contain *.servicehub.service.json files.

description: Service names of optional discovery service modules. Controller will use them to locate a service which it cannot find in the services folder.

required: controller hosts services

title: Microsoft ServiceHub Configuration


cirrus.json

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Script that is used to calculate cache key.

description: Path of a folder to cache.

description: In case of a cache miss this script will be executed.

description: Boolean expression. A flag to check if contents of folder has changed after a cache hit.

description: Destination path.

description: Environment variable name.

description: Boolean expression that can use environment variables.

description: ALWAYS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: List of task names this task depends on.

description: Map represented as an object.

description: Map represented as an object.

description: Lock name for triggering and execution

description: ON_FAILURE commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ON_SUCCESS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Windows version of container.

description: Container Platform.

description: List of required labels on a PR.

description: Task timeout in minutes

description: Trigger type

description: GKE cluster name.

description: Map represented as an object.

description: Map represented as an object.

description: Lock name for triggering and execution

description: Kubernetes namespace to schedule CI jobs in.

description: List of required labels on a PR.

description: Pipe resources

description: Pipe step

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ALWAYS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Docker Image to use.

description: ON_FAILURE commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ON_SUCCESS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Task timeout in minutes

description: Trigger type

description: Google Cloud zone of the cluster.

description: Map represented as an object.

description: Map represented as an object.

description: Lock name for triggering and execution

description: List of required labels on a PR.

description: Pipe resources

description: Pipe step

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ALWAYS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Docker Image to use.

description: ON_FAILURE commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ON_SUCCESS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Task timeout in minutes

description: Trigger type

description: Cirrus CI task definition.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ALWAYS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: Azure Container Instance definition.

description: Docker Image.

description: Container Platform.

description: Azure zone.

description: Compute Engine instance definition.

description: Image name or family.

description: Google Cloud project of an image.

description: VM platform.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Arguments for Docker build

description: Relative path to Dockerfile to build container from.

description: Docker Image to use.

description: AWS EC2 definition.

description: AMI Image.

description: Image Platform.

description: AWS region.

description: EKS Container definition.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: EKS cluster name.

description: Docker Image.

description: AWS region.

description: Map represented as an object.

description: Map represented as an object.

description: Lock name for triggering and execution

description: macOS Virtual Machine definition for Community Cluster.

description: FreeBSD VM image.

description: Image family.

description: Google Compute Engine Virtual Machine definition.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Container image.

description: Image family.

description: Image name.

description: Google Cloud project of an image.

description: Google Cloud Scopes of the VM.

description: Google Cloud zone where to start a VM.

description: Image family.

description: Image name.

description: Google Cloud project of an image.

description: VM platform.

description: Google Cloud Scopes of the VM.

description: Machine Type.

description: Google Cloud zone where to start a VM.

description: Google Kubernetes Engine Container definition.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Image name.

description: Google Cloud project of an image used to build Docker container from Dockerfile.

description: GKE cluster name.

description: Arguments for Docker build

description: Relative path to Dockerfile.

description: Docker Image.

description: Container Platform.

description: Google Cloud zone of the cluster.

description: macOS VM image.

description: ON_FAILURE commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: ON_SUCCESS commands.

description: Content Format.

description: Path or pattern of artifacts.

description: Path or pattern of artifacts.

description: Content Type.

description: Folder Cache Definition.

description: Path of a folder to cache.

description: Destination path.

description: Environment variable name.

description: macOS VM image.

description: Persistent Worker definition.

description: Persistent Worker isolation.

description: Parallels VM isolation.

description: Image name.

description: SSH password

description: Image Platform.

description: SSH username

description: Labels for selection.

description: List of required labels on a PR.

description: Task timeout in minutes

description: Trigger type

description: Windows Container definition for Community Cluster.

description: Arguments for Docker build

description: Docker Image to use.

description: Windows version of container.

description: Azure Container Instance definition.

description: Docker Image.

description: Container Platform.

description: Azure zone.

description: Compute Engine instance definition.

description: Image name or family.

description: Google Cloud project of an image.

description: VM platform.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Arguments for Docker build

description: Docker Image to use.

description: AWS EC2 definition.

description: AMI Image.

description: Image Platform.

description: AWS region.

description: EKS Container definition.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: EKS cluster name.

description: Docker Image.

description: AWS region.

description: Map represented as an object.

description: Map represented as an object.

description: FreeBSD VM image.

description: Image family.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Container image.

description: Image family.

description: Image name.

description: Google Cloud project of an image.

description: Google Cloud Scopes of the VM.

description: Google Cloud zone where to start a VM.

description: Image family.

description: Image name.

description: Google Cloud project of an image.

description: VM platform.

description: Google Cloud Scopes of the VM.

description: Machine Type.

description: Google Cloud zone where to start a VM.

description: Additional Container definition.

description: Container CMD to override.

description: Map represented as an object.

description: Map represented as an object.

description: Docker Image.

description: Port exposed by the container.

description: Container readiness probe command.

description: Image name.

description: GKE cluster name.

description: Arguments for Docker build

description: Relative path to Dockerfile.

description: Docker Image.

description: Container Platform.

description: Google Cloud zone of the cluster.

description: macOS VM image.

description: macOS VM image.

description: Persistent Worker definition.

description: Persistent Worker isolation.

description: Parallels VM isolation.

description: Image name.

description: SSH password

description: Image Platform.

description: SSH username

description: Labels for selection.

description: Task timeout in minutes

description: Trigger type

description: Arguments for Docker build

description: Docker Image to use.

description: Windows version of container.

title: JSON schema for Cirrus CI configuration files


schema-kas.json

title: kas configuration

description: kas, a setup tool for bitbake based projects

type: integer

required: repo file

enum: openembedded oe isar

type: boolean


title: api url info

title: template for all request

default: sql

title: cases to test

description: a schema for auto api cases

title: case


cityjson.min.schema.json

title: CityJSON v1.1.3

description: CityJSON specifications v1.1.3

format: email

enum: individual organization

description: from ISO 19115 codelist

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

format: uri

required: contactName emailAddress

format: date

type: number

format: uri-reference

required: url version

description: the IDs of the parents

description: the IDs of children

required: surfaces values

required: type lod boundaries

description: the IDs of the parents

description: the IDs of children

required: type template boundaries transformationMatrix

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

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

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

description: the IDs of the parents

description: the IDs of children

required: type transform version CityObjects vertices


curations-schema.json

title: ORT curations

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

$ref: #/definitions/hash

required: hash url

$ref: #/definitions/vcsMatcher

required: id curations

required: value algorithm


csscomb.json

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

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

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

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

enum: lower upper

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

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

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

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

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

enum: single double

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

title: A CSS Comb config schema


cicsts-resourcemodel.json

title: Resource model JSON Schema.

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

title: Resource model JSON Schema.

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


description: Which prop declaration method to use

enum: ts jsdoc prop-types none

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

description: Wether to use Typescript

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

description: Which styling solution to use

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

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

description: Whether to import React

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

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

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

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

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

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

enum: named default

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

enum: const function

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

enum: interface type

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

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

description: Whether to generate React Native components

description: Whether to log additional debug information

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

title: JSON schema for the Agrippa config file


meltano.schema.json

title: JSON Schema for meltano.yml

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

$ref: #/$defs/annotations

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

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

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

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

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

description: Configuration for state backend.

description: The URI pointing to the backend to use.

default: systemdb

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

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

description: Configuration for Azure Blob Storage state backend.

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

description: Configuration for Google Cloud Storage state backend.

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

description: Configuration for AWS S3 state backend.

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

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

description: S3 endpoint URL to use.

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

$ref: #/$defs/environments

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

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

$ref: #/$defs/plugins/extractors

$ref: #/$defs/plugins/loaders

$ref: #/$defs/plugins/mappers

$ref: #/$defs/plugins/orchestrators

$ref: #/$defs/plugins/transformers

$ref: #/$defs/plugins/files

$ref: #/$defs/plugins/utilities

$ref: #/$defs/plugins/transforms

$ref: #/$defs/schedules

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

$ref: #/$defs/env

$ref: #/$defs/jobs

description: Jobs, added using 'meltano job'

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

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

description: CLI related settings.

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

description: ELT related settings

description: The size of the ELT buffer in bytes.

description: Whether experimental features should be enabled.

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

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

description: Whether the API includes scheduled jobs in listings.

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

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

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

description: The URL for Meltano Hub.

type: string boolean null

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

description: Snowplow related settings.

description: Array of Snowplow collector endpoints.

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

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

description: The name of the plugin.

description: A description of the plugin.

description: The type of the plugin.

enum: extractors loaders orchestrators transformers files utilities transforms mappers

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

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

description: An existing plugin to inherit from.

description: The pip hosted package name or URL

description: The variant of the plugin.

description: The namespace of this plugin

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

description: A user friendly label describing the plugin

examples:
Stripe
Facebook Ads

description: An optional logo URL for this plugin

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

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

description: A URL to the documentation for this plugin

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

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

description: Command arguments

description: Documentation displayed when listing commands

description: Override the plugin's executable for this command

description: Container specification for this command

description: Container image

description: Container command

examples: list test compile

description: Container entrypoint

description: Mapping of host to container ports

description: Array of volumes to mount during container execution

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

description: The command as a string.

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

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

description: An object containing Singer stream and property metadata

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

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

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

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

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

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

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

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

description: An object containing dbt model variables

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

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

description: The name of the setting

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

description: A user friendly label for the setting

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

description: A placeholder value for this setting

description: The type of value this setting contains

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

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account

description: A phrase to provide additional information on this setting

description: A link to documentation on this setting

description: A protected setting cannot be changed from the UI

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

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

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

description: The name of a Meltano-supported OAuth provider

description: A user friendly label for the option

description: The value of this option

required: name extractor loader transform interval start_date

description: The schedule's unique name

description: The name of a meltano job

description: The name of the extractor plugin

description: The name of the loader plugin

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

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

description: The date when the schedule should first execute

description: This jobs unique name

description: The name of the environment.

description: An object of environment specific configurations.

description: An object of environment specific plugin configurations.

description: A set of plugin requirements.

description: A single plugin requirement

description: The name of the required plugin

description: The variant of the required plugin

description: Mapping of environment variables for use in config.


resjson.json

$ref: #/definitions/resource

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