openapi: 3.0.1 info: description: |- All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.
Endpoints designated as Superadmin-only are not tenant-scoped. title: Kestra EE version: 1.3.0 servers: - url: / tags: - description: Flows api name: Flows - description: Templates api name: Templates - description: Executions api name: Executions - description: Logs api name: Logs - description: Namespaces api name: Namespaces - description: Users api name: Users - description: Groups api name: Groups - description: Bindings api name: Bindings - description: Roles api name: Roles - description: Audit Logs api name: Audit Logs - description: Auth api name: Auths - description: Stats api name: Stats - description: Tenants api name: Tenants - description: Misc api name: Misc paths: /api/v1/auditlogs/export: get: operationId: exportAuditLogsForAllTenants parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: A namespace filter explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: A flow id filter explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - description: An execution filter explode: false in: query name: executionId required: false schema: nullable: true type: string style: form - description: A user id filter explode: false in: query name: userId required: false schema: nullable: true type: string style: form - description: A id filter explode: false in: query name: id required: false schema: nullable: true type: string style: form - description: A resource filter explode: false in: query name: resources required: false schema: items: $ref: "#/components/schemas/ResourceType" nullable: true type: array style: form - description: The start datetime explode: false in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: The end datetime explode: false in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: A list of auditLog details explode: false in: query name: details required: false schema: additionalProperties: type: string nullable: true type: object style: form - description: The event that create the audit log explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/CrudEventType" nullable: true style: form responses: "200": content: text/csv: schema: items: type: object type: array description: exportAuditLogsForAllTenants 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export all audit logs as a streamed CSV file tags: - Audit Logs x-internal: true /api/v1/auditlogs/search: get: operationId: searchAuditLogsForAllTenants parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: A namespace filter explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: A flow id filter explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - description: An execution filter explode: false in: query name: executionId required: false schema: nullable: true type: string style: form - description: A user id filter explode: false in: query name: userId required: false schema: nullable: true type: string style: form - description: A id filter explode: false in: query name: id required: false schema: nullable: true type: string style: form - description: A resource filter explode: false in: query name: resources required: false schema: items: $ref: "#/components/schemas/ResourceType" nullable: true type: array style: form - description: The start datetime explode: false in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: The end datetime explode: false in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: A list of auditLog details explode: false in: query name: details required: false schema: additionalProperties: type: string nullable: true type: object style: form - description: The event that create the audit log explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/CrudEventType" nullable: true style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AuditLogController.ApiAuditLogItem_" description: searchAuditLogsForAllTenants 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Search for audit logs across all tenants, required to be SuperAdmin" tags: - Audit Logs x-internal: true /api/v1/auditlogs/{id}/diff: get: description: Retrieves the diff between the current version and a selected previous version of a given resource based on audit logs. operationId: globalResourceDiffFromAuditLog parameters: - description: The id of the audit log explode: false in: path name: id required: true schema: type: string style: simple - description: The id of a previous audit log to compare with explode: false in: query name: previousId required: false schema: nullable: true type: string style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/AuditLogController.AuditLogDiff" description: getGlobalResourceDiffFromAuditLog 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve the diff between audit logs from global resource like users tags: - Audit Logs x-internal: true /api/v1/auths: get: operationId: index responses: "200": content: application/json: schema: $ref: "#/components/schemas/AuthController.Auth" description: index 200 response summary: Retrieve list of authentication methods tags: - Auths x-internal: true /api/v1/banners: post: description: Superadmin-only. Creates a global announcement banner visible to all tenants. operationId: createBanner requestBody: content: application/json: schema: $ref: "#/components/schemas/Banner" description: The announcement banner to create required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Banner" description: createBanner 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create an announcement banner tags: - Banners x-internal: true /api/v1/banners/search: get: description: Superadmin-only. Returns all global announcement banners. operationId: searchBanners responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Banner" type: array description: searchBanners 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve all announcement banners tags: - Banners x-internal: true /api/v1/banners/{id}: delete: description: Superadmin-only. Deletes a global announcement banner by its ID. operationId: deleteBanner parameters: - description: The banner id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": description: deleteBanner 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete an announcement banner tags: - Banners x-internal: true put: description: Superadmin-only. Updates a global announcement banner by its ID. operationId: updateBanner parameters: - description: The banner id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Banner" description: The banner to update required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Banner" description: updateBanner 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update an announcement banner tags: - Banners x-internal: true /api/v1/configs: get: description: Global endpoint available to all users. operationId: configuration responses: "200": content: application/json: schema: $ref: "#/components/schemas/MiscController.EEConfiguration" description: getConfiguration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve the instance configuration. tags: - Misc x-internal: false /api/v1/forgotten-password: get: description: "Sends an email to reset a password. Note that whatever the username\ \ is found or not, the response will always be 200 to avoid leaking information." operationId: forgottenPassword parameters: - description: User that has forgotten his password explode: false in: query name: username required: true schema: type: string style: form responses: "200": content: application/json: schema: type: object description: forgottenPassword 200 response summary: Sends an email to reset a password. tags: - Auths x-internal: true /api/v1/instance/maintenance/enter: post: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: enterMaintenance responses: "200": content: application/json: schema: type: object description: enterMaintenance 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enter cluster maintenance mode tags: - Cluster - Maintenance x-internal: true /api/v1/instance/maintenance/exit: post: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: exitMaintenance responses: "200": content: application/json: schema: type: object description: exitMaintenance 200 response security: - bearerAuth: [] - basicAuth: [] summary: Exit cluster maintenance mode tags: - Cluster - Maintenance x-internal: true /api/v1/instance/services/active: get: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: activeServices responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiActiveServiceList" description: getActiveServices 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all active services tags: - Services x-internal: true /api/v1/instance/services/search: get: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: searchServices parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The state filter explode: false in: query name: state required: false schema: items: $ref: "#/components/schemas/Service.ServiceState" nullable: true type: array style: form - description: The server type filter explode: false in: query name: type required: false schema: items: $ref: "#/components/schemas/ServiceType" nullable: true type: array style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_InstanceController.ApiServiceInstance_" description: searchServices 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Search for a service (e.g. Worker, Executor, etc)" tags: - Services x-internal: true /api/v1/instance/services/{id}: get: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: service parameters: - explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/ServiceInstance" description: getService 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve details of a specific service tags: - Services x-internal: true /api/v1/instance/versioned-plugins: get: description: Superadmin-only. Lists all currently installed plugin artifacts. Requires INFRASTRUCTURE permission. operationId: listVersionedPlugin parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The query explode: false in: query name: q required: false schema: nullable: true type: string style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_InstanceController.ApiPluginArtifact_" description: listVersionedPlugin 200 response security: - bearerAuth: [] - basicAuth: [] summary: List installed plugin artifacts tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/available: get: description: Superadmin-only. Lists all plugin artifacts available for installation. Requires INFRASTRUCTURE permission. operationId: listAvailableVersionedPlugins responses: "200": content: application/json: schema: type: object description: listAvailableVersionedPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: List available plugin artifacts tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/available/secrets-managers: get: description: Superadmin-only. Lists all secret managers available for installation. Requires INFRASTRUCTURE permission. operationId: listAvailableVersionedPluginsForSecretManager responses: "200": content: application/json: schema: type: object description: listAvailableVersionedPluginsForSecretManager 200 response security: - bearerAuth: [] - basicAuth: [] summary: List available plugin artifacts for Kestra Secret Manager tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/available/storages: get: description: Superadmin-only. Lists all internal storages available for installation. Requires INFRASTRUCTURE permission. operationId: listAvailableVersionedPluginsForStorage responses: "200": content: application/json: schema: type: object description: listAvailableVersionedPluginsForStorage 200 response security: - bearerAuth: [] - basicAuth: [] summary: List available plugin artifacts for Kestra Internal Storage tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/install: post: description: Superadmin-only. Installs one or more plugin artifacts. Requires INFRASTRUCTURE permission. operationId: installVersionedPlugins requestBody: content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginListRequest" description: List of plugins required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginArtifactList_PluginArtifact_" description: installVersionedPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: Install specified plugin artifacts tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/resolve: post: description: Superadmin-only. Resolves compatible versions for a list of plugin artifacts. Requires INFRASTRUCTURE permission. operationId: resolveVersionedPlugins requestBody: content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginListRequest" description: List of plugins required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginArtifactList_PluginResolutionResult_" description: resolveVersionedPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: Resolve versions for specified plugin artifacts tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/uninstall: delete: description: Superadmin-only. Uninstalls one or more plugin artifacts. Requires INFRASTRUCTURE permission. operationId: uninstallVersionedPlugins requestBody: content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginListRequest" description: List of plugins required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginArtifactList_PluginArtifact_" description: uninstallVersionedPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: Uninstall plugin artifacts tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/upload: post: description: Superadmin-only. Uploads a plugin JAR file for installation. Requires INFRASTRUCTURE permission. operationId: uploadVersionedPlugins requestBody: content: multipart/form-data: encoding: file: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/uploadVersionedPlugins_request" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/PluginArtifact" description: uploadVersionedPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: Upload a plugin artifact JAR file tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/{groupId}/{artifactId}: get: description: Superadmin-only. Retrieves metadata and available versions for a given plugin artifact. Requires INFRASTRUCTURE permission. operationId: versionedPluginDetails parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple - explode: false in: path name: artifactId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginVersions" description: getVersionedPluginDetails 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve details of a plugin artifact tags: - Plugins x-internal: true /api/v1/instance/versioned-plugins/{groupId}/{artifactId}/{version}: get: description: Superadmin-only. Retrieves metadata for a specific version of a plugin artifact. Requires INFRASTRUCTURE permission. operationId: versionedPluginDetailsFromVersion parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple - explode: false in: path name: artifactId required: true schema: type: string style: simple - explode: false in: path name: version required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiPluginVersionDetails" description: getVersionedPluginDetailsFromVersion 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve details of a specific plugin artifact version tags: - Plugins x-internal: true /api/v1/instance/workergroups: get: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: listWorkerGroups responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiWorkerGroupList" description: listWorkerGroups 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all worker groups tags: - WorkerGroups x-internal: true post: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: createWorkerGroup requestBody: content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiCreateOrUpdateWorkerGroupRequest" description: The worker group definition required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiWorkerGroup" description: createWorkerGroup 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a worker group tags: - WorkerGroups x-internal: true /api/v1/instance/workergroups/{id}: delete: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: deleteWorkerGroupById parameters: - explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteWorkerGroupById 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a worker group tags: - WorkerGroups x-internal: true get: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: workerGroupById parameters: - explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiWorkerGroupDetails" description: getWorkerGroupById 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve details of a specific worker group tags: - WorkerGroups x-internal: true put: description: Requires a role with the INFRASTRUCTURE permission (Superadmin-only). operationId: updateWorkerGroupById parameters: - explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiCreateOrUpdateWorkerGroupRequest" description: The worker group definition required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstanceController.ApiWorkerGroup" description: updateWorkerGroupById 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a worker group tags: - WorkerGroups x-internal: true /api/v1/invitation/accept/{invitationId}: post: operationId: acceptInvitation parameters: - explode: false in: path name: invitationId required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: acceptInvitation 200 response tags: - Auths x-internal: true /api/v1/invitation/create/{invitationId}: post: operationId: createFromInvitation parameters: - explode: false in: path name: invitationId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AuthController.InvitationUserRequest" description: The basic information to create an account from an invitation required: true responses: "200": content: application/json: schema: type: object description: createFromInvitation 200 response tags: - Auths x-internal: true /api/v1/kill-switches: post: description: Superadmin-only. Creates a kill switch. operationId: createKillSwitch requestBody: content: application/json: schema: $ref: "#/components/schemas/KillSwitch" description: The kill switch to create required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/KillSwitch" description: createKillSwitch 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a kill switch tags: - KillSwitches x-internal: true /api/v1/kill-switches/search: get: description: Superadmin-only. Returns all kill switches. operationId: searchKillSwitches responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/KillSwitch" type: array description: searchKillSwitches 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve all kill switches tags: - KillSwitches x-internal: true /api/v1/kill-switches/{id}: delete: description: Superadmin-only. Deletes a kill switch by its ID. operationId: deleteKillSwitch parameters: - description: The kill switch id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": description: deleteKillSwitch 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a kill switch tags: - KillSwitches x-internal: true put: description: Superadmin-only. Updates a kill switch by its ID. operationId: updateKillSwitch parameters: - description: The kill switch id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/KillSwitch" description: The kill switch to update required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/KillSwitch" description: updateKillSwitch 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a kill switch tags: - KillSwitches x-internal: true /api/v1/license-info: get: description: "Global endpoint, available to any authenticated user." operationId: licenseInfo responses: "200": content: application/json: schema: $ref: "#/components/schemas/MiscController.LicenseInfo" description: licenseInfo 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve license information tags: - Misc x-internal: false /api/v1/main-tenant-flows: get: operationId: mainTenantFlows responses: "200": content: application/json: schema: type: boolean description: mainTenantFlows 200 response security: - bearerAuth: [] - basicAuth: [] summary: Check if flows are present on the main tenant. tags: - Misc x-internal: false /api/v1/me: get: description: Requires the ME permission. operationId: currentUser responses: "200": content: application/json: schema: $ref: "#/components/schemas/MeController.ApiMe" description: getCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get details about the authenticated user tags: - Auths x-internal: true patch: description: Updates the authenticated user's profile information and returns the updated user. operationId: patchCurrentUser requestBody: content: application/json: schema: $ref: "#/components/schemas/MeController.ApiUserDetailsRequest" description: The user details required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/MeController.ApiMe" description: patchCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update authenticated user details tags: - Auths x-internal: true /api/v1/me/api-tokens: get: description: Returns all API tokens belonging to the authenticated user. operationId: listApiTokensForCurrentUser responses: "200": content: application/json: schema: $ref: "#/components/schemas/ApiTokenList" description: listApiTokensForCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: List API tokens for authenticated user tags: - Auths x-internal: true post: operationId: createApiTokenForCurrentUser requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenResponse" description: createApiTokenForCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create API token for the authenticated user tags: - Auths x-internal: true /api/v1/me/api-tokens/{tokenId}: delete: operationId: deleteApiTokenForCurrentUser parameters: - description: The token id explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteApiTokenForCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete API token for the authenticated user tags: - Auths x-internal: true /api/v1/me/invitations: get: description: Returns all invitations for the authenticated user's email across all tenants. operationId: findAllInvitationsForCurrentUser responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Invitation" type: array description: findAllInvitationsForCurrentUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: List invitations for the authenticated user tags: - Invitations x-internal: true /api/v1/me/password: put: description: Changes the login password for the authenticated user. operationId: updateCurrentUserPassword requestBody: content: application/json: schema: $ref: "#/components/schemas/MeController.ApiUpdatePasswordRequest" required: true responses: "200": content: application/json: schema: type: object description: updateCurrentUserPassword 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update authenticated user password tags: - Users x-internal: false /api/v1/plugins: get: operationId: listPlugins responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Plugin" type: array description: listPlugins 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get list of plugins tags: - Plugins x-internal: true /api/v1/plugins/groups/subgroups: get: operationId: pluginBySubgroups responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Plugin" type: array description: getPluginBySubgroups 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get plugins group by subgroups tags: - Plugins x-internal: true /api/v1/plugins/icons: get: operationId: pluginIcons responses: "200": content: application/json: schema: additionalProperties: $ref: "#/components/schemas/PluginIcon" type: object description: getPluginIcons 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get plugins icons tags: - Plugins x-internal: true /api/v1/plugins/icons/groups: get: operationId: pluginGroupIcons responses: "200": content: application/json: schema: additionalProperties: $ref: "#/components/schemas/PluginIcon" type: object description: getPluginGroupIcons 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get plugins icons tags: - Plugins x-internal: true /api/v1/plugins/inputs: get: operationId: allInputTypes responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/InputType" type: array description: getAllInputTypes 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get all types for an inputs tags: - Plugins x-internal: true /api/v1/plugins/inputs/{type}: get: description: "The schema will be a [JSON Schema Draft 7](http://json-schema.org/draft-07/schema)" operationId: schemaFromInputType parameters: - description: The schema needed explode: false in: path name: type required: true schema: $ref: "#/components/schemas/Type" style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/DocumentationWithSchema" description: getSchemaFromInputType 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get the JSON schema for an input type tags: - Plugins x-internal: true /api/v1/plugins/properties/{type}: get: description: "The schema will be a [JSON Schema Draft 7](http://json-schema.org/draft-07/schema)" operationId: propertiesFromType parameters: - description: The schema needed explode: false in: path name: type required: true schema: $ref: "#/components/schemas/SchemaType" style: simple responses: "200": content: application/json: schema: additionalProperties: type: object type: object description: getPropertiesFromType 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get the properties part of the JSON schema for a type tags: - Plugins x-internal: true /api/v1/plugins/schemas/{type}: get: description: "The schema will be a [JSON Schema Draft 7](http://json-schema.org/draft-07/schema)" operationId: schemasFromType parameters: - description: The schema needed explode: false in: path name: type required: true schema: $ref: "#/components/schemas/SchemaType" style: simple - description: If schema should be an array of requested type explode: false in: query name: arrayOf required: true schema: default: false type: boolean style: form responses: "200": content: application/json: schema: additionalProperties: type: object type: object description: getSchemasFromType 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get the JSON schema for a type tags: - Plugins x-internal: true /api/v1/plugins/{cls}: get: operationId: pluginDocumentation parameters: - description: The plugin full class name explode: false in: path name: cls required: true schema: type: string style: simple - description: Include all the properties explode: false in: query name: all required: true schema: default: false type: boolean style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/DocumentationWithSchema" description: getPluginDocumentation 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get plugin documentation tags: - Plugins x-internal: true /api/v1/plugins/{cls}/versions: get: operationId: pluginVersions parameters: - description: The plugin type explode: false in: path name: cls required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PluginController.ApiPluginVersions" description: getPluginVersions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get all versions for a plugin tags: - Plugins x-internal: true /api/v1/plugins/{cls}/versions/{version}: get: operationId: pluginDocumentationFromVersion parameters: - description: The plugin type explode: false in: path name: cls required: true schema: type: string style: simple - description: The plugin version explode: false in: path name: version required: true schema: type: string style: simple - description: Include all the properties explode: false in: query name: all required: true schema: default: false type: boolean style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/DocumentationWithSchema" description: getPluginDocumentationFromVersion 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get plugin documentation tags: - Plugins x-internal: true /api/v1/request-code/{email}: get: operationId: requestCode parameters: - explode: false in: path name: email required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: requestCode 200 response summary: Request an authentication code for login verification tags: - Auths x-internal: true /api/v1/reset-password: post: description: "Change a password for given token. If password does not match\ \ password policy, use can still retry." operationId: resetPassword requestBody: content: application/json: schema: $ref: "#/components/schemas/AuthController.ResetPasswordRequest" description: The password required: true responses: "200": content: application/json: schema: type: object description: resetPassword 200 response summary: Change a password for given token. tags: - Auths x-internal: true /api/v1/service-accounts: get: operationId: listServiceAccounts parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMServiceAccountController.ApiServiceAccountDetail_" description: Service account successfully created "404": description: Group not found security: - bearerAuth: [] - basicAuth: [] summary: 'List service accounts. Superadmin-only. ' tags: - ServiceAccount x-internal: false post: description: Superadmin-only. CReate service account with access to multiple tenants. operationId: createServiceAccount requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiCreateServiceAccountRequest" description: The service account required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountDetail" description: Service account successfully created security: - bearerAuth: [] - basicAuth: [] summary: Create a service account tags: - ServiceAccount x-internal: false /api/v1/service-accounts/{id}: delete: description: Superadmin-only. Delete a service account including all its access. operationId: deleteServiceAccount parameters: - description: The service account id explode: false in: path name: id required: true schema: type: string style: simple responses: "204": description: Service account successfully deleted "404": description: Service account not found security: - bearerAuth: [] - basicAuth: [] summary: Delete a service account tags: - ServiceAccount x-internal: false get: description: Superadmin-only. Get user account details. operationId: serviceAccount parameters: - description: The service account id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountDetail" description: getServiceAccount 200 response "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Get a service account tags: - ServiceAccount x-internal: false patch: description: Superadmin-only. Updates the details of a service account. operationId: patchServiceAccountDetails parameters: - description: The service account id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiPatchServiceAccountRequest" description: The service account details required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountDetail" description: patchServiceAccountDetails 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update service account details tags: - ServiceAccount x-internal: false /api/v1/service-accounts/{id}/api-tokens: get: operationId: listApiTokensForServiceAccount parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: listApiTokensForServiceAccount 200 response security: - bearerAuth: [] - basicAuth: [] summary: List API tokens for a specific service account tags: - ServiceAccount x-internal: false post: operationId: createApiTokensForServiceAccount parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenRequest" description: The create api-token request required: true responses: "200": content: application/json: schema: type: object description: createApiTokensForServiceAccount 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create new API Token for a specific service account tags: - ServiceAccount x-internal: false /api/v1/service-accounts/{id}/api-tokens/{tokenId}: delete: operationId: deleteApiTokenForServiceAccount parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - description: The token id explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteApiTokenForServiceAccount 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete an API Token for specific service account and token id tags: - ServiceAccount x-internal: false /api/v1/service-accounts/{id}/superadmin: patch: description: Superadmin-only. Updates whether a service account is a superadmin. operationId: patchServiceAccountSuperAdmin parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiPatchSuperAdminRequest" required: true responses: "200": description: Service account successfully updated "404": description: Service account not found security: - bearerAuth: [] - basicAuth: [] summary: Update service account superadmin privileges tags: - ServiceAccount x-internal: false /api/v1/setup: get: operationId: setupConfiguration responses: "200": content: application/json: schema: $ref: "#/components/schemas/SetupConfiguration" description: setupConfiguration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve current setup configuration tags: - Misc x-internal: false /api/v1/tenants: post: description: Superadmin-only. operationId: create requestBody: content: application/json: schema: $ref: "#/components/schemas/Tenant" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Tenant" description: create 200 response summary: Create a tenant tags: - Tenants x-internal: true /api/v1/tenants/search: get: description: Superadmin-only. operationId: find parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Tenant_" description: find 200 response summary: Search for tenants tags: - Tenants x-internal: true /api/v1/tenants/{id}: delete: description: "Superadmin-only. Deletes all resources linked to the tenant, including\ \ flows, namespaces, apps, etc." operationId: delete parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple responses: "204": description: On success summary: Delete a tenant and all its resources tags: - Tenants x-internal: true get: description: Superadmin-only. operationId: get parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Tenant" description: get 200 response summary: Retrieve a tenant tags: - Tenants x-internal: true put: description: Superadmin-only. operationId: update parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Tenant" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Tenant" description: update 200 response summary: Update a tenant tags: - Tenants x-internal: true /api/v1/tenants/{id}/apps-catalog: get: description: Superadmin-only. operationId: appsCatalogConfig parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/TenantController.AppsCatalogConfigResponse" description: getAppsCatalogConfig 200 response summary: Get the apps catalog config for the specified tenant. tags: - Tenants x-internal: true post: description: Superadmin-only. operationId: setAppsCatalogConfig parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TenantController.AppsCatalogConfigRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TenantController.AppsCatalogConfigResponse" description: setAppsCatalogConfig 200 response summary: Set the apps catalog config for the specified tenant. tags: - Tenants x-internal: true /api/v1/tenants/{id}/apps-catalog/logo: delete: description: Superadmin-only. operationId: deleteAppsCatalogLogo parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": description: deleteAppsCatalogLogo 200 response summary: Remove the apps catalog logo for the specified tenant. tags: - Tenants x-internal: true post: description: Superadmin-only. operationId: setAppsCatalogLogo parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: logo: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/setAppsCatalogLogo_request" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TenantController.AppsCatalogConfigResponse" description: setAppsCatalogLogo 200 response summary: Set the apps catalog logo for the specified tenant. tags: - Tenants x-internal: true /api/v1/tenants/{id}/logo: post: description: Superadmin-only. operationId: setLogo parameters: - description: The tenant id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: logo: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/setAppsCatalogLogo_request" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ApiTenant" description: setLogo 200 response summary: Set a tenant logo tags: - Tenants x-internal: true /api/v1/users: get: operationId: listUsers parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMUserController.ApiUserSummary_" description: listUsers 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve users tags: - Users x-internal: false post: description: Superadmin-only. Create a new user account with an optional password based authentication method. operationId: createUser requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiCreateOrUpdateUserRequest" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: User was successfully created "404": description: "Tenant, or group not found" security: - bearerAuth: [] - basicAuth: [] summary: Create a new user account tags: - Users x-internal: false /api/v1/users/{id}: delete: description: Superadmin-only. Delete a user including all its access. operationId: deleteUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "204": description: User successfully deleted "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Delete a user tags: - Users x-internal: false get: description: Superadmin-only. Get user account details. operationId: user parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: getUser 200 response "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Get a user tags: - Users x-internal: false patch: description: Superadmin-only. Updates the the details of a user. operationId: patchUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/MeController.ApiUserDetailsRequest" description: The user details required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: patchUser 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update user details tags: - Users x-internal: false put: description: Superadmin-only. Update an existing user account with an optional password based authentication method. operationId: updateUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiCreateOrUpdateUserRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: updateUser 200 response "404": description: "Tenant, or group not found" security: - bearerAuth: [] - basicAuth: [] summary: Update a user account tags: - Users x-internal: false /api/v1/users/{id}/api-tokens: get: description: Superadmin-only. Get all API token existing for a user. operationId: listApiTokensForUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/ApiTokenList" description: listApiTokensForUser 200 response "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: List API tokens for a specific user tags: - Users x-internal: false post: description: Superadmin-only. Create a new API token for a user. operationId: createApiTokensForUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenRequest" description: The create api-token request required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenResponse" description: API token successfully created "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Create new API Token for a specific user tags: - Users x-internal: false /api/v1/users/{id}/api-tokens/{tokenId}: delete: description: Superadmin-only. Delete an API token for a user. operationId: deleteApiTokenForUser parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - description: The token id explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "204": description: API token successfully deleted "404": description: "User, or API Token not found" security: - bearerAuth: [] - basicAuth: [] summary: Delete an API Token for specific user and token id tags: - Users x-internal: false /api/v1/users/{id}/auths/{auth}: delete: description: Superadmin-only. Updates whether a user is a superadmin. operationId: deleteUserAuthMethod parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - description: The user auth method id explode: false in: path name: auth required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: User auth method successfully updated "404": description: User or auth method not found security: - bearerAuth: [] - basicAuth: [] summary: Update user password tags: - Users x-internal: false /api/v1/users/{id}/impersonate: post: description: Superadmin-only. Allows an admin to impersonate another user. operationId: impersonate parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: impersonate 200 response "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Impersonate a user tags: - Users x-internal: false /api/v1/users/{id}/password: patch: description: Superadmin-only. Updates whether a user is a superadmin. operationId: patchUserPassword parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiPatchUserPasswordRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiUser" description: User successfully updated "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Update user password tags: - Users x-internal: false /api/v1/users/{id}/refresh-token: delete: operationId: deleteRefreshToken parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple responses: "204": description: Refresh token successfully deleted "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Delete a user refresh token tags: - Users x-internal: false /api/v1/users/{id}/restricted: patch: description: Superadmin-only. Updates whether a user is for demo. operationId: patchUserDemo parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMUserController.ApiPatchRestrictedRequest" required: true responses: "200": description: User successfully updated "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Update user demo tags: - Users x-internal: false /api/v1/users/{id}/superadmin: patch: description: Superadmin-only. Updates whether a user is a superadmin. operationId: patchUserSuperAdmin parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiPatchSuperAdminRequest" required: true responses: "200": description: User successfully updated "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Update user superadmin privileges tags: - Users x-internal: false /api/v1/{tenant}/acls/actions: get: description: "Actions are used to restrict possible operations for each permission.\ \ Each action must be one of the following: CREATE, READ, UPDATE, DELETE.\ \ Using permissions and actions together, you can control access to resources\ \ e.g. only allow a user to read a flow, but not update or delete it." operationId: listActions parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Action" type: array description: listActions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve list of actions tags: - Misc x-internal: false /api/v1/{tenant}/ai/generate/app: post: operationId: generateApp parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AppGenerationPrompt" description: Prompt and context required for app generation required: true responses: "200": content: application/yaml: schema: type: string description: generateApp 200 response summary: Generate or regenerate an app based on a prompt (EE only) tags: - AI x-internal: true /api/v1/{tenant}/ai/generate/dashboard: post: operationId: generateDashboard parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/DashboardGenerationPrompt" description: Prompt and context required for dashboard generation required: true responses: "200": content: application/yaml: schema: type: string description: generateDashboard 200 response summary: Generate or regenerate a dashboard based on a prompt tags: - AI x-internal: true /api/v1/{tenant}/ai/generate/flow: post: operationId: generateFlow parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/FlowGenerationPrompt" description: Prompt and context required for flow generation required: true responses: "200": content: application/yaml: schema: type: string description: generateFlow 200 response summary: Generate or regenerate a flow based on a prompt tags: - AI x-internal: true /api/v1/{tenant}/ai/generate/test: post: operationId: generateTestSuite parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteGenerationPrompt" description: Prompt and context required for test suite generation required: true responses: "200": content: application/yaml: schema: type: string description: generateTestSuite 200 response summary: Generate or regenerate a test suite based on a prompt (EE only) tags: - AI x-internal: true /api/v1/{tenant}/ai/providers: get: operationId: providers parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/AiController.AiProviderResponse" type: array description: getProviders 200 response summary: List available AI providers tags: - AI x-internal: true /api/v1/{tenant}/apps: delete: operationId: bulkDeleteApps parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiBulkOperationRequest" description: The list of Apps UID required: true responses: "200": content: application/json: schema: type: object description: bulkDeleteApps 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete existing apps tags: - Apps x-internal: true post: operationId: createApp parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The app required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiAppSource" description: createApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a new app tags: - Apps x-internal: true /api/v1/{tenant}/apps/catalog: get: operationId: searchAppsFromCatalog parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: Tags filter explode: false in: query name: tags required: false schema: items: type: string nullable: true type: array style: form - description: String filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AppsController.ApiAppCatalogItem_" description: searchAppsFromCatalog 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for apps from catalog tags: - Apps x-internal: true /api/v1/{tenant}/apps/disable: post: operationId: bulkDisableApps parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiBulkOperationRequest" description: The list of Apps UID required: true responses: "200": content: application/json: schema: type: object description: bulkDisableApps 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable existing apps tags: - Apps x-internal: true /api/v1/{tenant}/apps/enable: post: operationId: bulkEnableApps parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiBulkOperationRequest" description: The list of Apps UID required: true responses: "200": content: application/json: schema: type: object description: bulkEnableApps 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enable existing apps tags: - Apps x-internal: true /api/v1/{tenant}/apps/export: post: operationId: bulkExportApps parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiBulkOperationRequest" description: The list of Apps UID required: true responses: "200": content: application/octet-stream: schema: format: byte type: string description: bulkExportApps 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export apps as a ZIP archive of YAML sources. tags: - Apps x-internal: true /api/v1/{tenant}/apps/import: post: operationId: bulkImportApps parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: fileUpload: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/bulkImportApps_request" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiBulkImportResponse" description: On success security: - bearerAuth: [] - basicAuth: [] summary: |2 Import apps as a ZIP archive of yaml sources or a multi-objects YAML file. When sending a Yaml that contains one or more apps, a list of index is returned. When sending a ZIP archive, a list of files that couldn't be imported is returned. tags: - Apps x-internal: true /api/v1/{tenant}/apps/search: get: operationId: searchApps parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: A tags filter explode: false in: query name: tags required: false schema: items: type: string nullable: true type: array style: form - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: A namespace filter prefix explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: A flow id filter explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AppsController.ApiApp_" description: searchApps 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for apps tags: - Apps x-internal: true /api/v1/{tenant}/apps/tags: get: operationId: listTags parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiAppTags" description: listTags 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get all the app tags tags: - Apps x-internal: true /api/v1/{tenant}/apps/{uid}: delete: operationId: deleteApp parameters: - description: The ID of the app explode: false in: path name: uid required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete an existing app tags: - Apps x-internal: true get: operationId: app parameters: - description: The ID of the app explode: false in: path name: uid required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiAppSource" description: getApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve an app tags: - Apps x-internal: true put: operationId: updateApp parameters: - description: The ID of the app explode: false in: path name: uid required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The app required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiAppSource" description: updateApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update an existing app tags: - Apps x-internal: true /api/v1/{tenant}/apps/{uid}/disable: post: operationId: disableApp parameters: - description: The ID of app explode: false in: path name: uid required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiApp" description: disableApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable the app. tags: - Apps x-internal: true /api/v1/{tenant}/apps/{uid}/enable: post: operationId: enableApp parameters: - description: The ID of app explode: false in: path name: uid required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AppsController.ApiApp" description: enableApp 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enable the app. tags: - Apps x-internal: true /api/v1/{tenant}/assets: post: operationId: createAsset parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The asset required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AssetsController.ApiAsset" description: createAsset 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a new asset tags: - Assets x-internal: true /api/v1/{tenant}/assets/by-ids: delete: operationId: deleteAssetsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The asset ids required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: Number of deleted assets "400": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: If any assetId didn't match an existing asset security: - bearerAuth: [] - basicAuth: [] summary: Delete assets by asset ids tags: - Assets x-internal: true /api/v1/{tenant}/assets/by-query: delete: operationId: deleteAssetsByQuery parameters: - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - description: "If true, will purge instead of soft-delete" explode: false in: query name: purge required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: Number of deleted assets "400": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: If any assetId didn't match an existing asset security: - bearerAuth: [] - basicAuth: [] summary: Delete assets by query tags: - Assets x-internal: true /api/v1/{tenant}/assets/lineage-events/by-query: delete: operationId: deleteAssetLineageEventsByQuery parameters: - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: deleteAssetLineageEventsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Delete asset lineage events by query, hard-delete (purge) only" tags: - Assets x-internal: true /api/v1/{tenant}/assets/lineage-events/search: get: operationId: searchAssetLineageEvents parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AssetsController.ApiAssetLineageEvent_" description: searchAssetLineageEvents 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for asset lineage events tags: - Assets x-internal: true /api/v1/{tenant}/assets/search: get: operationId: searchAssets parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AssetsController.ApiAsset_" description: searchAssets 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for assets tags: - Assets x-internal: true /api/v1/{tenant}/assets/usages/by-query: delete: operationId: deleteAssetUsagesByQuery parameters: - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: deleteAssetUsagesByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Delete asset usages by query, hard-delete (purge) only" tags: - Assets x-internal: true /api/v1/{tenant}/assets/usages/search: get: operationId: searchAssetUsages parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AssetsController.ApiAssetUsage_" description: searchAssetUsages 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for asset usages tags: - Assets x-internal: true /api/v1/{tenant}/assets/{id}: delete: operationId: deleteAsset parameters: - description: The ID of the asset explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteAsset 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete an asset tags: - Assets x-internal: true get: operationId: asset parameters: - description: The ID of the asset explode: false in: path name: id required: true schema: type: string style: simple - description: Get asset even if soft deleted explode: false in: query name: allowDeleted required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AssetsController.ApiAsset" description: getAsset 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve an asset tags: - Assets x-internal: true /api/v1/{tenant}/assets/{id}/dependencies: get: operationId: assetDependencies parameters: - description: The asset id explode: false in: path name: id required: true schema: type: string style: simple - description: "If true, list only destination dependencies, otherwise list\ \ also source dependencies" explode: false in: query name: destinationOnly required: true schema: default: false type: boolean style: form - description: "If true, expand all dependencies recursively" explode: false in: query name: expandAll required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AssetTopologyGraph" description: getAssetDependencies 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get an asset dependencies tags: - Assets x-internal: true /api/v1/{tenant}/auditlogs/export: get: operationId: exportAuditLogs parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: A namespace filter explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: A flow id filter explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - description: An execution filter explode: false in: query name: executionId required: false schema: nullable: true type: string style: form - description: A user id filter explode: false in: query name: userId required: false schema: nullable: true type: string style: form - description: A id filter explode: false in: query name: id required: false schema: nullable: true type: string style: form - description: A resource filter explode: false in: query name: resources required: false schema: items: $ref: "#/components/schemas/ResourceType" nullable: true type: array style: form - description: The start datetime explode: false in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: The end datetime explode: false in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: A list of auditLog details explode: false in: query name: details required: false schema: additionalProperties: type: string nullable: true type: object style: form - description: The event that create the audit log explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/CrudEventType" nullable: true style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/csv: schema: items: type: object type: array description: exportAuditLogs 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export all audit logs as a streamed CSV file tags: - Audit Logs x-internal: true /api/v1/{tenant}/auditlogs/find: post: operationId: findAuditLog parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/AuditLogController.FindRequest" description: The find request required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AuditLogController.ApiAuditLogItem" description: findAuditLog 200 response security: - bearerAuth: [] - basicAuth: [] summary: Find a specific audit log tags: - Audit Logs x-internal: true /api/v1/{tenant}/auditlogs/history/{detailId}: get: operationId: listAuditLogFromResourceId parameters: - description: The resource Id explode: false in: path name: detailId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/AuditLogController.AuditLogOption" type: array description: listAuditLogFromResourceId 200 response security: - bearerAuth: [] - basicAuth: [] summary: Find all audit logs about a specific resource. tags: - Audit Logs x-internal: true /api/v1/{tenant}/auditlogs/search: get: operationId: searchAuditLogs parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: A namespace filter explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: A flow id filter explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - description: An execution filter explode: false in: query name: executionId required: false schema: nullable: true type: string style: form - description: A user id filter explode: false in: query name: userId required: false schema: nullable: true type: string style: form - description: A id filter explode: false in: query name: id required: false schema: nullable: true type: string style: form - description: A resource filter explode: false in: query name: resources required: false schema: items: $ref: "#/components/schemas/ResourceType" nullable: true type: array style: form - description: The start datetime explode: false in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: The end datetime explode: false in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: A list of auditLog details explode: false in: query name: details required: false schema: additionalProperties: type: string nullable: true type: object style: form - description: The event that create the audit log explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/CrudEventType" nullable: true style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_AuditLogController.ApiAuditLogItem_" description: searchAuditLogs 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for audit logs tags: - Audit Logs x-internal: true /api/v1/{tenant}/auditlogs/{id}/diff: get: description: Retrieves the diff between the current version and a selected previous version of a given resource based on audit logs. operationId: resourceDiffFromAuditLog parameters: - description: The id of the audit log explode: false in: path name: id required: true schema: type: string style: simple - description: The id of a previous audit log to compare with explode: false in: query name: previousId required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/AuditLogController.AuditLogDiff" description: getResourceDiffFromAuditLog 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve the diff between audit logs tags: - Audit Logs x-internal: true /api/v1/{tenant}/bindings: post: operationId: createBinding parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMBindingController.ApiCreateBindingRequest" description: The binding required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMBindingController.ApiBindingDetail" description: createBinding 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a binding tags: - Bindings x-internal: true /api/v1/{tenant}/bindings/bulk: post: operationId: bulkCreateBinding parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/IAMBindingController.ApiCreateBindingRequest" type: array description: The bindings required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/IAMBindingController.ApiBindingDetail" type: array description: bulkCreateBinding 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create multiple bindings tags: - Bindings x-internal: true /api/v1/{tenant}/bindings/search: get: operationId: searchBindings parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Binding type filter explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/Binding.Type" nullable: true style: form - description: External id filter explode: false in: query name: id required: false schema: nullable: true type: string style: form - description: A namespace filter explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMBindingController.ApiBindingDetail_" description: searchBindings 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for bindings tags: - Bindings x-internal: true /api/v1/{tenant}/bindings/{id}: delete: operationId: deleteBinding parameters: - description: The binding id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: On success security: - bearerAuth: [] - basicAuth: [] summary: Delete a binding tags: - Bindings x-internal: true get: operationId: binding parameters: - description: The binding id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMBindingController.ApiBindingDetail" description: getBinding 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve a binding tags: - Bindings x-internal: true /api/v1/{tenant}/blueprints/community/{kind}: get: description: Lists all community blueprints of the specified kind. Community blueprints are shared and versioned. operationId: searchBlueprints parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The sort of current page explode: false in: query name: sort required: false schema: nullable: true type: string style: form - description: A tags filter explode: false in: query name: tags required: false schema: items: type: string nullable: true type: array style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The blueprint kind explode: false in: path name: kind required: true schema: $ref: "#/components/schemas/BlueprintController.Kind" style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_BlueprintController.ApiBlueprintItem_" description: searchBlueprints 200 response summary: List all blueprints tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/community/{kind}/tags: get: description: "Lists tags for community blueprints of the specified kind, optionally\ \ filtered by query." operationId: listBlueprintTags parameters: - description: The blueprint kind explode: false in: path name: kind required: true schema: $ref: "#/components/schemas/BlueprintController.Kind" style: simple - description: A string filter to get tags with matching blueprints only explode: false in: query name: q required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/BlueprintController.ApiBlueprintTagItem" type: array description: listBlueprintTags 200 response summary: List blueprint tags matching the filter tags: - Blueprint Tags x-internal: true /api/v1/{tenant}/blueprints/community/{kind}/{id}: get: description: Retrieves details of a specific community blueprint. operationId: blueprint parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - description: The blueprint kind explode: false in: path name: kind required: true schema: $ref: "#/components/schemas/BlueprintController.Kind" style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiBlueprintItemWithSource" description: getBlueprint 200 response summary: Retrieve a blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/community/{kind}/{id}/graph: get: description: Retrieves the topology graph representation of a specific community blueprint. operationId: blueprintGraph parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - description: The blueprint kind explode: false in: path name: kind required: true schema: $ref: "#/components/schemas/BlueprintController.Kind" style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: additionalProperties: type: object type: object description: getBlueprintGraph 200 response summary: Retrieve a blueprint graph tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/community/{kind}/{id}/source: get: description: Retrieves the YAML source code for a specific community blueprint. operationId: blueprintSource parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - description: The blueprint kind explode: false in: path name: kind required: true schema: $ref: "#/components/schemas/BlueprintController.Kind" style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/yaml: schema: type: string description: getBlueprintSource 200 response summary: Retrieve a blueprint source code tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/custom: get: description: Lists all internal (custom) blueprints for the current tenant. Requires BLUEPRINT permission. operationId: searchInternalBlueprints parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The sort of current page explode: false in: query name: sort required: false schema: nullable: true type: string style: form - description: A tags filter explode: false in: query name: tags required: false schema: items: type: string nullable: true type: array style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 1 format: int32 type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Blueprint_" description: searchInternalBlueprints 200 response summary: List all internal blueprints tags: - Blueprints x-internal: true post: deprecated: true description: Creates a new internal (custom) blueprint for the current tenant. Requires BLUEPRINT permission. operationId: createInternalBlueprints parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiBlueprintItemWithSource" description: The internal blueprint to create required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiBlueprintItemWithSource" description: createInternalBlueprints 200 response summary: Create a new internal blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/custom/tags: get: description: Lists all tags used by internal (custom) blueprints for the current tenant. operationId: internalBlueprintTags parameters: - description: A string filter to get tags with matching blueprints only explode: false in: query name: q required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: internalBlueprintTags 200 response summary: List all internal blueprint tags tags: - Blueprint Tags x-internal: true /api/v1/{tenant}/blueprints/custom/{id}: delete: deprecated: true description: Deletes an internal (custom) blueprint for the current tenant. Requires BLUEPRINT permission. operationId: deleteInternalBlueprints parameters: - description: The internal blueprint id to delete explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteInternalBlueprints 200 response summary: Delete an internal blueprint tags: - Blueprints x-internal: true get: description: Retrieves details of a specific internal (custom) blueprint. Requires BLUEPRINT permission. operationId: internalBlueprint parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiFlowBlueprint" description: internalBlueprint 200 response summary: Retrieve an internal blueprint tags: - Blueprints x-internal: true put: deprecated: true description: Updates an existing internal (custom) blueprint for the current tenant. Requires BLUEPRINT permission. operationId: updateInternalBlueprints parameters: - description: The id of the internal blueprint to update explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiBlueprintItemWithSource" description: The new internal blueprint for update required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintWithFlowEntity" description: updateInternalBlueprints 200 response summary: Update an internal blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/custom/{id}/source: get: description: Retrieves the YAML source code for a specific internal (custom) blueprint. Requires BLUEPRINT permission. operationId: internalBlueprintFlow parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/yaml: schema: type: string description: internalBlueprintFlow 200 response summary: Retrieve an internal blueprint source code tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/flow/{id}: get: description: Retrieves details of a specific flow blueprint. Requires BLUEPRINT permission. operationId: flowBlueprint parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiFlowBlueprint" description: getFlowBlueprint 200 response summary: Retrieve an flow blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/flows: post: operationId: createFlowBlueprint parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/BlueprintController.FlowBlueprintCreateOrUpdate" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiFlowBlueprint" description: createFlowBlueprint 200 response summary: Create a Flow Blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/flows/{id}: delete: description: Deletes an Flow Blueprint for the current tenant. Requires BLUEPRINT permission. operationId: deleteFlowBlueprints parameters: - description: The flow blueprint id to delete explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteFlowBlueprints 200 response summary: Delete an Flow Blueprint tags: - Blueprints x-internal: true get: description: Retrieves details of a specific flow blueprint. Requires BLUEPRINT permission. operationId: flowBlueprintById parameters: - description: The blueprint id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiFlowBlueprint" description: getFlowBlueprintById 200 response summary: Retrieve an flow blueprint tags: - Blueprints x-internal: true put: operationId: updateFlowBlueprint parameters: - description: The flow blueprint id to update explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/BlueprintController.FlowBlueprintCreateOrUpdate" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.ApiFlowBlueprint" description: updateFlowBlueprint 200 response summary: Update a Flow Blueprint tags: - Blueprints x-internal: true /api/v1/{tenant}/blueprints/flows/{id}/use-template: post: operationId: useBlueprintTemplate parameters: - description: The flow blueprint id to use explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/BlueprintController.UseBlueprintTemplateRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BlueprintController.UseBlueprintTemplateResponse" description: useBlueprintTemplate 200 response summary: Use a Flow Blueprint template to generate a Flow source tags: - Blueprints x-internal: true /api/v1/{tenant}/concurrency-limit/search: get: operationId: searchConcurrencyLimits parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_ConcurrencyLimit_" description: searchConcurrencyLimits 200 response summary: Search for flow concurrency limits tags: - Flows x-internal: false /api/v1/{tenant}/concurrency-limit/{namespace}/{flowId}: put: operationId: updateConcurrencyLimit parameters: - explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: flowId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ConcurrencyLimit" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConcurrencyLimit" description: updateConcurrencyLimit 200 response summary: Update a flow concurrency limit tags: - Flows x-internal: false /api/v1/{tenant}/dashboards: get: operationId: searchDashboards parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The filter query explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Dashboard_" description: searchDashboards 200 response summary: Search for dashboards tags: - Dashboards x-internal: true post: operationId: createDashboard parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The dashboard definition as YAML required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Dashboard" description: createDashboard 200 response summary: Create a dashboard from yaml source tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/charts/export/to-csv: post: operationId: exportChartToCsv parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/DashboardController.PreviewRequest" required: true responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportChartToCsv 200 response summary: Export a table chart data to CSV tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/charts/preview: post: operationId: previewChart parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/DashboardController.PreviewRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Map_String.Object__" description: previewChart 200 response summary: Preview a chart data tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/validate: post: operationId: validateDashboard parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The dashboard definition as YAML required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ValidateConstraintViolation" description: validateDashboard 200 response summary: Validate dashboard from yaml source tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/validate/chart: post: operationId: validateChart parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The chart definition as YAML required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ValidateConstraintViolation" description: validateChart 200 response summary: Validate a chart from yaml source tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/{id}: delete: operationId: deleteDashboard parameters: - description: The dashboard id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteDashboard 200 response summary: Delete a dashboard tags: - Dashboards x-internal: true get: operationId: dashboard parameters: - description: The dashboard id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Dashboard" description: getDashboard 200 response summary: Get a dashboard tags: - Dashboards x-internal: true put: operationId: updateDashboard parameters: - description: The dashboard id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The dashboard definition as YAML required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Dashboard" description: updateDashboard 200 response summary: Update a dashboard tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/{id}/charts/{chartId}: post: operationId: dashboardChartData parameters: - description: The dashboard id explode: false in: path name: id required: true schema: type: string style: simple - description: The chart id explode: false in: path name: chartId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ChartFiltersOverrides" description: "The filters to apply, some can override chart definition like\ \ labels & namespace" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Map_String.Object__" description: getDashboardChartData 200 response summary: Generate a dashboard chart data tags: - Dashboards x-internal: true /api/v1/{tenant}/dashboards/{id}/charts/{chartId}/export/to-csv: post: operationId: exportDashboardChartDataToCSV parameters: - description: The dashboard id explode: false in: path name: id required: true schema: type: string style: simple - description: The chart id explode: false in: path name: chartId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ChartFiltersOverrides" description: "The filters to apply, some can override chart definition like\ \ labels & namespace" required: true responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportDashboardChartDataToCSV 200 response summary: Export a dashboard chart data to CSV tags: - Dashboards x-internal: true /api/v1/{tenant}/dependencies: get: operationId: flowDependenciesFromTenant parameters: - description: "if true, list only destination dependencies, otherwise list\ \ also source dependencies" explode: false in: query name: destinationOnly required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowTopologyGraph" description: getFlowDependenciesFromTenant 200 response summary: Get tenant dependencies tags: - Tenants x-internal: true /api/v1/{tenant}/executions: get: operationId: searchExecutionsByFlowId parameters: - description: The flow namespace explode: false in: query name: namespace required: true schema: type: string style: form - description: The flow id explode: false in: query name: flowId required: true schema: type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Execution_" description: searchExecutionsByFlowId 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for executions for a flow tags: - Executions x-internal: false /api/v1/{tenant}/executions/by-ids: delete: operationId: deleteExecutionsByIds parameters: - description: Whether to delete non-terminated executions explode: false in: query name: includeNonTerminated required: false schema: default: false nullable: true type: boolean style: form - description: Whether to delete execution logs explode: false in: query name: deleteLogs required: false schema: default: true type: boolean style: form - description: Whether to delete execution metrics explode: false in: query name: deleteMetrics required: false schema: default: true type: boolean style: form - description: Whether to delete execution files in the internal storage explode: false in: query name: deleteStorage required: false schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The execution id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Deleted with errors security: - bearerAuth: [] - basicAuth: [] summary: Delete a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/by-query: delete: operationId: deleteExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - description: Whether to delete non-terminated executions explode: false in: query name: includeNonTerminated required: false schema: default: false nullable: true type: boolean style: form - description: Whether to delete execution logs explode: false in: query name: deleteLogs required: false schema: default: true type: boolean style: form - description: Whether to delete execution metrics explode: false in: query name: deleteMetrics required: false schema: default: true type: boolean style: form - description: Whether to delete execution files in the internal storage explode: false in: query name: deleteStorage required: false schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/change-status/by-ids: post: operationId: updateExecutionsStatusByIds parameters: - description: The new state of the executions explode: false in: query name: newStatus required: true schema: $ref: "#/components/schemas/State.Type" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Changed state with errors security: - bearerAuth: [] - basicAuth: [] summary: Change executions state by id tags: - Executions x-internal: false /api/v1/{tenant}/executions/change-status/by-query: post: operationId: updateExecutionsStatusByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - description: The new state of the executions explode: false in: query name: newStatus required: true schema: $ref: "#/components/schemas/State.Type" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Changed state with errors security: - bearerAuth: [] - basicAuth: [] summary: Change executions state by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/flows/{namespace}/{flowId}: get: operationId: flowFromExecution parameters: - description: The namespace of the flow explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The flow revision explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowForExecution" description: getFlowFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get flow information's for an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/force-run/by-ids: post: operationId: forceRunByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Force run with errors security: - bearerAuth: [] - basicAuth: [] summary: Force run a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/force-run/by-query: post: operationId: forceRunExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: forceRunExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Force run executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/kill/by-ids: delete: operationId: killExecutionsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Killed with errors security: - bearerAuth: [] - basicAuth: [] summary: Kill a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/kill/by-query: delete: operationId: killExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: killExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Kill executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/labels/by-ids: post: operationId: setLabelsOnTerminatedExecutionsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ExecutionController.SetLabelsByIdsRequest" description: The request containing a list of labels and a list of executions required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Killed with errors security: - bearerAuth: [] - basicAuth: [] summary: Set labels on a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/labels/by-query: post: operationId: setLabelsOnTerminatedExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Label" type: array description: The labels to add to the execution required: true responses: "200": content: application/json: schema: type: object description: setLabelsOnTerminatedExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Set label on executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/latest: post: operationId: latestExecutions parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/ExecutionRepositoryInterface.FlowFilter" type: array required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ExecutionController.LastExecutionResponse" type: array description: getLatestExecutions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get the latest execution for given flows tags: - Executions x-internal: false /api/v1/{tenant}/executions/pause/by-ids: post: operationId: pauseExecutionsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Paused with errors security: - bearerAuth: [] - basicAuth: [] summary: Pause a list of running executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/pause/by-query: post: operationId: pauseExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: pauseExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Pause executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/replay/by-ids: post: operationId: replayExecutionsByIds parameters: - description: If latest revision should be used explode: false in: query name: latestRevision required: false schema: default: false nullable: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Replayed with errors security: - bearerAuth: [] - basicAuth: [] summary: Create new executions from old ones. Keep the flow revision tags: - Executions x-internal: false /api/v1/{tenant}/executions/replay/by-query: post: operationId: replayExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - description: If latest revision should be used explode: false in: query name: latestRevision required: false schema: default: false nullable: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: replayExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create new executions from old ones filter by query parameters. Keep the flow revision tags: - Executions x-internal: false /api/v1/{tenant}/executions/restart/by-ids: post: operationId: restartExecutionsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Restarted with errors security: - bearerAuth: [] - basicAuth: [] summary: Restart a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/restart/by-query: post: operationId: restartExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: restartExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Restart executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/resume/by-ids: post: operationId: resumeExecutionsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Resumed with errors security: - bearerAuth: [] - basicAuth: [] summary: Resume a list of paused executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/resume/by-query: post: operationId: resumeExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: resumeExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Resume executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/search: get: operationId: searchExecutions parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Execution_" description: searchExecutions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/unqueue/by-ids: post: operationId: unqueueExecutionsByIds parameters: - description: The new state of the unqueued executions explode: false in: query name: state required: true schema: $ref: "#/components/schemas/State.Type" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: The list of executions id required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: On success "422": content: application/json: schema: $ref: "#/components/schemas/BulkErrorResponse" description: Unqueued with errors security: - bearerAuth: [] - basicAuth: [] summary: Unqueue a list of executions tags: - Executions x-internal: false /api/v1/{tenant}/executions/unqueue/by-query: post: operationId: unqueueExecutionsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - description: The new state of the unqueued executions explode: false in: query name: newState required: false schema: allOf: - $ref: "#/components/schemas/State.Type" nullable: true style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: unqueueExecutionsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unqueue executions filter by query parameters tags: - Executions x-internal: false /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}: get: operationId: triggerExecutionByGetWebhook parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The webhook trigger uid explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/WebhookResponse" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Trigger a new execution by GET webhook trigger tags: - Executions x-internal: false /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path}: get: operationId: triggerExecutionByGetWebhookWithPath parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The webhook trigger uid explode: false in: path name: key required: true schema: type: string style: simple - description: Optional additional path segments explode: false in: path name: path required: true schema: nullable: true type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/WebhookResponse" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Trigger a new execution by GET webhook trigger tags: - Executions x-internal: false post: operationId: triggerExecutionByPostWebhookWithPath parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The webhook trigger uid explode: false in: path name: key required: true schema: type: string style: simple - description: Optional additional path segments explode: false in: path name: path required: true schema: nullable: true type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/WebhookResponse" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Trigger a new execution by POST webhook trigger tags: - Executions x-internal: false put: operationId: triggerExecutionByPutWebhookWithPath parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The webhook trigger uid explode: false in: path name: key required: true schema: type: string style: simple - description: Optional additional path segments explode: false in: path name: path required: true schema: nullable: true type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/WebhookResponse" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Trigger a new execution by PUT webhook trigger tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}: delete: operationId: deleteExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: Whether to delete execution logs explode: false in: query name: deleteLogs required: false schema: default: true type: boolean style: form - description: Whether to delete execution metrics explode: false in: query name: deleteMetrics required: false schema: default: true type: boolean style: form - description: Whether to delete execution files in the internal storage explode: false in: query name: deleteStorage required: false schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteExecution 200 response "204": description: On success security: - bearerAuth: [] - basicAuth: [] summary: Delete an execution tags: - Executions x-internal: false get: operationId: execution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: getExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/change-status: post: operationId: updateExecutionStatus parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The new state of the execution explode: false in: query name: status required: true schema: $ref: "#/components/schemas/State.Type" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: updateExecutionStatus 200 response security: - bearerAuth: [] - basicAuth: [] summary: Change the state of an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/file: get: operationId: downloadFileFromExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: true schema: format: uri type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: binary type: string description: downloadFileFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Download file for an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/file/metas: get: operationId: fileMetadatasFromExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: true schema: format: uri type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FileMetas" description: getFileMetadatasFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get file meta information for an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/flow: get: operationId: flowFromExecutionById parameters: - description: The execution that you want flow information explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowForExecution" description: getFlowFromExecutionById 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get flow information's for an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/follow: get: operationId: followExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/event-stream: schema: $ref: "#/components/schemas/Event_Execution_" description: followExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Follow an execution tags: - Executions x-sdk-customization: x-replace-follow-execution: "true" x-skipped: "true" x-internal: false /api/v1/{tenant}/executions/{executionId}/follow-dependencies: get: operationId: followDependenciesExecutions parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: "If true, list only destination dependencies, otherwise list\ \ also source dependencies" explode: false in: query name: destinationOnly required: true schema: default: false type: boolean style: form - description: "If true, expand all dependencies recursively" explode: false in: query name: expandAll required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/event-stream: schema: $ref: "#/components/schemas/Event_ExecutionStatusEvent_" description: followDependenciesExecutions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Follow all execution dependencies executions tags: - Executions x-sdk-customization: x-replace-follow-dependencies-execution: "true" x-skipped: "true" x-internal: false /api/v1/{tenant}/executions/{executionId}/force-run: post: operationId: forceRunExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: forceRunExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Force run an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/graph: get: operationId: executionFlowGraph parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The subflow tasks to display explode: false in: query name: subflows required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowGraph" description: getExecutionFlowGraph 200 response security: - bearerAuth: [] - basicAuth: [] summary: Generate a graph for an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/kill: delete: operationId: killExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: Specifies whether killing the execution also kill all subflow executions. explode: false in: query name: isOnKillCascade required: true schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/json: schema: type: object description: killExecution 200 response "202": description: Execution kill was requested successfully "404": description: if the executions is not found "409": description: if the executions is already finished security: - bearerAuth: [] - basicAuth: [] summary: Kill an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/labels: post: operationId: setLabelsOnTerminatedExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Label" type: array description: The labels to add to the execution required: true responses: "200": content: application/json: schema: type: object description: setLabelsOnTerminatedExecution 200 response "400": description: If the execution is not terminated "404": description: If the execution cannot be found security: - bearerAuth: [] - basicAuth: [] summary: Add or update labels of a terminated execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/pause: post: operationId: pauseExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: pauseExecution 200 response "204": description: On success "409": description: if the executions is not running security: - bearerAuth: [] - basicAuth: [] summary: Pause a running execution. tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/replay: post: operationId: replayExecution parameters: - description: the original execution id to clone explode: false in: path name: executionId required: true schema: type: string style: simple - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The flow revision to use for new execution explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - description: "Set a list of breakpoints at specific tasks 'id.value', separated\ \ by a coma." explode: false in: query name: breakpoints required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: replayExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a new execution from an old one and start it from a specified task run id tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/replay-with-inputs: post: operationId: replayExecutionWithinputs parameters: - description: the original execution id to clone explode: false in: path name: executionId required: true schema: type: string style: simple - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The flow revision to use for new execution explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - description: "Set a list of breakpoints at specific tasks 'id.value', separated\ \ by a coma." explode: false in: query name: breakpoints required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: schema: additionalProperties: true items: format: binary type: string type: array description: The inputs (multipart map) required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: replayExecutionWithinputs 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a new execution from an old one and start it from a specified task run id tags: - Executions x-sdk-customization: x-multipart: "true" x-internal: false /api/v1/{tenant}/executions/{executionId}/restart: post: operationId: restartExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The flow revision to use for new execution explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: restartExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Restart a new execution from an old one tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/resume: post: operationId: resumeExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: schema: items: format: binary type: string type: array description: The inputs required: true responses: "200": content: application/json: schema: type: object description: resumeExecution 200 response "204": description: On success "409": description: if the executions is not paused security: - bearerAuth: [] - basicAuth: [] summary: Resume a paused execution. tags: - Executions x-sdk-customization: x-multipart: "true" x-internal: false /api/v1/{tenant}/executions/{executionId}/state: post: operationId: updateTaskRunState parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ExecutionController.StateRequest" description: the taskRun id and state to apply required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: updateTaskRunState 200 response security: - bearerAuth: [] - basicAuth: [] summary: Change state for a taskrun in an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{executionId}/unqueue: post: operationId: unqueueExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The new state of the execution explode: false in: query name: state required: true schema: $ref: "#/components/schemas/State.Type" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Execution" description: unqueueExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unqueue an execution tags: - Executions x-internal: false /api/v1/{tenant}/executions/{namespace}/{id}: post: operationId: createExecution parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The labels as a list of 'key:value' explode: true in: query name: labels required: false schema: items: type: string nullable: true type: array style: form - description: If the server will wait the end of the execution explode: false in: query name: wait required: true schema: default: false type: boolean style: form - description: The flow revision or latest if null explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - description: Schedule the flow on a specific date explode: false in: query name: scheduleDate required: false schema: format: date-time nullable: true type: string style: form - description: "Set a list of breakpoints at specific tasks 'id.value', separated\ \ by a coma." explode: false in: query name: breakpoints required: false schema: nullable: true type: string style: form - description: Specific execution kind explode: false in: query name: kind required: false schema: allOf: - $ref: "#/components/schemas/ExecutionKind" nullable: true style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: schema: items: format: binary type: string type: array description: The inputs responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExecutionController.ExecutionResponse" description: On execution created "409": description: if the flow is disabled security: - bearerAuth: [] - basicAuth: [] summary: Create a new execution for a flow tags: - Executions x-sdk-customization: x-multipart: "true" x-internal: false /api/v1/{tenant}/flows: post: operationId: createFlow parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The flow source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowWithSource" description: createFlow 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a flow from yaml source tags: - Flows x-internal: false /api/v1/{tenant}/flows/bulk: post: description: |- All flow will be created / updated for this namespace. Flow that already created but not in `flows` will be deleted if the query delete is `true` operationId: bulkUpdateFlows parameters: - description: If missing flow should be deleted explode: false in: query name: delete required: true schema: default: true type: boolean style: form - description: The namespace where to update flows explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: If namespace child should are allowed to be updated explode: false in: query name: allowNamespaceChild required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: nullable: true type: string description: A list of flows source code split with "---" responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/FlowInterface" type: array description: bulkUpdateFlows 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update from multiples yaml sources tags: - Flows x-internal: false /api/v1/{tenant}/flows/delete/by-ids: delete: operationId: deleteFlowsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/IdWithNamespace" type: array description: A list of tuple flow ID and namespace as flow identifiers required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: deleteFlowsByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete flows by their IDs. tags: - Flows x-internal: false /api/v1/{tenant}/flows/delete/by-query: delete: operationId: deleteFlowsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: deleteFlowsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete flows returned by the query parameters. tags: - Flows x-internal: false /api/v1/{tenant}/flows/disable/by-ids: post: operationId: disableFlowsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/IdWithNamespace" type: array description: A list of tuple flow ID and namespace as flow identifiers required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: disableFlowsByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable flows by their IDs. tags: - Flows x-internal: false /api/v1/{tenant}/flows/disable/by-query: post: operationId: disableFlowsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: disableFlowsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable flows returned by the query parameters. tags: - Flows x-internal: false /api/v1/{tenant}/flows/distinct-namespaces: get: operationId: listDistinctNamespaces parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: listDistinctNamespaces 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all distinct namespaces tags: - Flows x-internal: false /api/v1/{tenant}/flows/enable/by-ids: post: operationId: enableFlowsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/IdWithNamespace" type: array description: A list of tuple flow ID and namespace as flow identifiers required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: enableFlowsByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enable flows by their IDs. tags: - Flows x-internal: false /api/v1/{tenant}/flows/enable/by-query: post: operationId: enableFlowsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: enableFlowsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enable flows returned by the query parameters. tags: - Flows x-internal: false /api/v1/{tenant}/flows/export/by-ids: post: operationId: exportFlowsByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/IdWithNamespace" type: array description: A list of tuple flow ID and namespace as flow identifiers required: true responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportFlowsByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export flows as a ZIP archive of yaml sources. tags: - Flows x-internal: false /api/v1/{tenant}/flows/export/by-query: get: operationId: exportFlowsByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportFlowsByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export flows as a ZIP archive of yaml sources. tags: - Flows x-internal: false /api/v1/{tenant}/flows/graph: post: operationId: generateFlowGraphFromSource parameters: - description: The subflow tasks to display explode: false in: query name: subflows required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The flow source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowGraph" description: generateFlowGraphFromSource 200 response security: - bearerAuth: [] - basicAuth: [] summary: Generate a graph for a flow source tags: - Flows x-internal: false /api/v1/{tenant}/flows/import: post: operationId: importFlows parameters: - description: If should fail on invalid flows explode: false in: query name: failOnError required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: fileUpload: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/bulkImportApps_request" required: true responses: "200": content: application/json: schema: items: type: string type: array description: On success security: - bearerAuth: [] - basicAuth: [] summary: |2 Import flows as a ZIP archive of yaml sources or a multi-objects YAML file. When sending a Yaml that contains one or more flows, a list of index is returned. When sending a ZIP archive, a list of files that couldn't be imported is returned. tags: - Flows x-internal: false /api/v1/{tenant}/flows/search: get: operationId: searchFlows parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Flow_" description: searchFlows 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for flows tags: - Flows x-internal: false /api/v1/{tenant}/flows/source: get: operationId: searchFlowsBySourceCode parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: A namespace filter prefix explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_SearchResult_Flow__" description: searchFlowsBySourceCode 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for flows source code tags: - Flows x-internal: false /api/v1/{tenant}/flows/validate: post: operationId: validateFlows parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string multipart/form-data: schema: type: object description: Flows as YAML string or multipart files required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ValidateConstraintViolation" type: array description: validateFlows 200 response security: - bearerAuth: [] - basicAuth: [] summary: Validate a list of flows tags: - Flows x-internal: false /api/v1/{tenant}/flows/validate/task: post: operationId: validateTask parameters: - description: The type of task explode: false in: query name: section required: true schema: $ref: "#/components/schemas/FlowController.TaskValidationType" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: object application/json: schema: type: object example: null description: A task definition that can be from tasks or triggers required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ValidateConstraintViolation" description: validateTask 200 response security: - bearerAuth: [] - basicAuth: [] summary: Validate a task tags: - Flows x-internal: false /api/v1/{tenant}/flows/validate/trigger: post: operationId: validateTrigger parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: type: object description: The trigger required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ValidateConstraintViolation" description: validateTrigger 200 response security: - bearerAuth: [] - basicAuth: [] summary: Validate trigger tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}: get: operationId: listFlowsByNamespace parameters: - description: Namespace to filter flows explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Flow" type: array description: listFlowsByNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve all flows from a given namespace tags: - Flows x-internal: false post: description: |- All flow will be created / updated for this namespace. Flow that already created but not in `flows` will be deleted if the query delete is `true` operationId: updateFlowsInNamespace parameters: - description: If missing flow should be deleted explode: false in: query name: delete required: true schema: default: true type: boolean style: form - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple - description: If namespace of all provided flows should be overridden explode: false in: query name: override required: true schema: default: false type: boolean style: form requestBody: content: application/x-yaml: schema: type: string description: A list of flows source code required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/FlowInterface" type: array description: updateFlowsInNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a complete namespace from yaml source tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}: delete: operationId: deleteFlow parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteFlow 200 response "204": description: On success security: - bearerAuth: [] - basicAuth: [] summary: Delete a flow tags: - Flows x-internal: false get: operationId: flow parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: Include the source code explode: false in: query name: source required: true schema: default: false type: boolean style: form - description: Get latest revision by default explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - description: Get flow even if deleted explode: false in: query name: allowDeleted required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowWithSource" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Get a flow tags: - Flows x-internal: false put: operationId: updateFlow parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The flow source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowWithSource" description: On success security: - bearerAuth: [] - basicAuth: [] summary: Update a flow tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}/dependencies: get: operationId: flowDependencies parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: "If true, list only destination dependencies, otherwise list\ \ also source dependencies" explode: false in: query name: destinationOnly required: true schema: default: false type: boolean style: form - description: "If true, expand all dependencies recursively" explode: false in: query name: expandAll required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowTopologyGraph" description: getFlowDependencies 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get flow dependencies tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}/graph: get: operationId: generateFlowGraph parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The flow revision explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - description: The subflow tasks to display explode: false in: query name: subflows required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowGraph" description: Return a FlowGraph object security: - bearerAuth: [] - basicAuth: [] summary: Generate a graph for a flow tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}/revisions: delete: operationId: deleteRevisions parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: revisions required: true schema: items: format: int32 minimum: 1 type: integer minItems: 1 type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteRevisions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete revisions for a flow tags: - Flows x-internal: false get: operationId: listFlowRevisions parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: allowDelete required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/FlowWithSource" type: array description: listFlowRevisions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get revisions for a flow tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}/tasks/{taskId}: get: operationId: taskFromFlow parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The task id explode: false in: path name: taskId required: true schema: type: string style: simple - description: The flow revision explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Task" description: getTaskFromFlow 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get a flow task tags: - Flows x-internal: false /api/v1/{tenant}/flows/{namespace}/{id}/{taskId}: patch: deprecated: true operationId: updateTask parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: id required: true schema: type: string style: simple - description: The task id explode: false in: path name: taskId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Task" description: The task required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Flow" description: updateTask 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a single task on a flow tags: - Flows x-internal: false /api/v1/{tenant}/groups: post: operationId: createGroup parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiCreateGroupRequest" description: The group required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupDetail" description: Group was created successfully "409": description: A group with the given name already exists security: - bearerAuth: [] - basicAuth: [] summary: Create a group tags: - Groups x-internal: false /api/v1/{tenant}/groups/autocomplete: post: operationId: autocompleteGroups parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiAutocomplete" description: Autocomplete request required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ApiGroupSummary" type: array description: autocompleteGroups 200 response security: - bearerAuth: [] - basicAuth: [] summary: List groups for autocomplete tags: - Groups x-internal: false /api/v1/{tenant}/groups/ids: post: operationId: listGroupIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiIds" description: The ids that must be present on results required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ApiGroupSummary" type: array description: listGroupIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: List groups by ids tags: - Groups x-internal: false /api/v1/{tenant}/groups/search: get: operationId: searchGroups parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_ApiGroupSummary_" description: searchGroups 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for groups tags: - Groups x-internal: false /api/v1/{tenant}/groups/{id}: delete: operationId: deleteGroup parameters: - description: The group id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: Group was deleted successfully "404": description: Group not found security: - bearerAuth: [] - basicAuth: [] summary: Delete a group tags: - Groups x-internal: false get: description: Retrieves details of a specific group by its ID within the current tenant. operationId: group parameters: - description: The group id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupDetail" description: Group details successfully retrieved "404": description: Group not found security: - bearerAuth: [] - basicAuth: [] summary: Retrieve a group tags: - Groups x-internal: false put: operationId: updateGroup parameters: - description: The group id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiUpdateGroupRequest" description: The group required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupDetail" description: Group was updated successfully "404": description: Group not found "409": description: A group with the given name already exists security: - bearerAuth: [] - basicAuth: [] summary: Update a group tags: - Groups x-internal: false /api/v1/{tenant}/groups/{id}/members: get: operationId: searchGroupMembers parameters: - description: The group id explode: false in: path name: id required: true schema: type: string style: simple - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMGroupController.ApiGroupMember_" description: searchGroupMembers 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for users in a group tags: - Groups x-internal: false /api/v1/{tenant}/groups/{id}/members/membership/{userId}: put: description: Allows a group owner or an authorized user to change the role of a user within a group to OWNER or MEMBER. operationId: setUserMembershipForGroup parameters: - description: The ID of the group explode: false in: path name: id required: true schema: type: string style: simple - description: The ID of the user whose membership is being updated explode: false in: path name: userId required: true schema: type: string style: simple - description: The new membership type to assign to the user. explode: false in: query name: membership required: true schema: $ref: "#/components/schemas/GroupIdentifier.Membership" style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupMember" description: Membership type successfully updated "404": description: User or group not found "409": description: User is not a member of the group security: - bearerAuth: [] - basicAuth: [] summary: Update a user's membership type in a group tags: - Groups x-internal: false /api/v1/{tenant}/groups/{id}/members/{userId}: delete: description: "Removes the specified user from the given group. If the user has\ \ no other group bindings within the tenant, their access to the tenant will\ \ also be revoked." operationId: deleteUserFromGroup parameters: - description: The ID of the group explode: false in: path name: id required: true schema: type: string style: simple - description: The ID of the user to remove from the group explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupMember" description: User was successfully removed from the group "404": description: Group or user not found "409": description: User is not a member of the group security: - bearerAuth: [] - basicAuth: [] summary: Remove a user from a group tags: - Groups x-internal: false put: description: "Adds the specified user to the given group. If the user does not\ \ already have access to the tenant, tenant access will be created automatically." operationId: addUserToGroup parameters: - description: The ID of the group explode: false in: path name: id required: true schema: type: string style: simple - description: The ID of the user to add to the group explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMGroupController.ApiGroupMember" description: User was successfully added to the group "404": description: Group or user not found "409": description: User is already a member of the group security: - bearerAuth: [] - basicAuth: [] summary: Add a user to a group tags: - Groups x-internal: false /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups: get: description: Find by a combination of query parameters operationId: queryGroups parameters: - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: query name: filter required: false schema: nullable: true type: string style: form - explode: false in: query name: sortBy required: false schema: nullable: true type: string style: form - explode: false in: query name: sortOrder required: false schema: allOf: - $ref: "#/components/schemas/SortOrder" nullable: true style: form - explode: false in: query name: startIndex required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: query name: count required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true post: description: Create operationId: createSCIMResourceByIdGroups parameters: - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/ScimUser" required: true responses: "201": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: Created "400": description: Bad Request "409": description: Conflict "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/.search: post: description: Search operationId: findGroups parameters: - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/SearchRequest" required: true responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/{id}: delete: description: Delete from the backing store operationId: deleteGroups parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true get: description: Find by id operationId: sCIMResourceByIdGroups parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true patch: description: Patch a portion of the backing store operationId: patchGroups parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/PatchRequest" required: true responses: "204": description: No Content "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true put: description: Update operationId: updateGroups parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" required: true responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Groups x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/ResourceTypes: get: description: Get All Resource Types operationId: allResourceTypes parameters: - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: items: $ref: "#/components/schemas/ResourceType_1" type: array description: OK response tags: - SCIM-Configuration x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/ResourceTypes/{name}: get: description: Get Resource Type by URN operationId: resourceType parameters: - explode: false in: path name: name required: true schema: type: string style: simple - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ResourceType_1" description: OK response tags: - SCIM-Configuration x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Schemas: get: description: Get All Schemas operationId: allSchemas parameters: - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: items: $ref: "#/components/schemas/Schema" type: array description: OK response tags: - SCIM-Configuration x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Schemas/{uri}: get: description: Get Schemas by URN operationId: schema parameters: - explode: false in: path name: uri required: true schema: type: string style: simple - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/Schema" description: OK response tags: - SCIM-Configuration x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/ServiceProviderConfig: get: description: Get Service Provider Configuration operationId: serviceProviderConfiguration parameters: - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ServiceProviderConfiguration" description: OK response tags: - SCIM-Configuration x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Users: get: description: Find by a combination of query parameters operationId: queryUsers parameters: - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: query name: filter required: false schema: nullable: true type: string style: form - explode: false in: query name: sortBy required: false schema: nullable: true type: string style: form - explode: false in: query name: sortOrder required: false schema: allOf: - $ref: "#/components/schemas/SortOrder" nullable: true style: form - explode: false in: query name: startIndex required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: query name: count required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true post: description: Create operationId: createSCIMResourceByIdUsers parameters: - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/ScimUser" required: true responses: "201": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: Created "400": description: Bad Request "409": description: Conflict "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/.search: post: description: Search operationId: findUsers parameters: - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/SearchRequest" required: true responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/{id}: delete: description: Delete from the backing store operationId: deleteUsers parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true get: description: Find by id operationId: sCIMResourceByIdUsers parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true patch: description: Patch a portion of the backing store operationId: patchUsers parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/PatchRequest" required: true responses: "204": description: No Content "400": description: Bad Request "404": description: Not found "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true put: description: Update operationId: updateUsers parameters: - explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: query name: attributes required: false schema: nullable: true type: string style: form - explode: false in: query name: excludedAttributes required: false schema: nullable: true type: string style: form - explode: false in: path name: integration required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" required: true responses: "200": content: application/scim+json: schema: $ref: "#/components/schemas/ScimResource" description: OK response "400": description: Bad Request "500": description: Internal Server Error "501": description: Not Implemented tags: - SCIM-Users x-internal: true /api/v1/{tenant}/invitations: post: description: Creates a new invitation and sends an email if the mail server is enabled. operationId: createInvitation parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMInvitationController.ApiInvitationCreateRequest" description: "Create a new invitation, send an email if the server-mail is\ \ enabled" required: true responses: "201": description: Invitation successfully created "204": description: Tenant access granted to the user "403": description: Insufficient privileges to invite a Superadmin user "409": description: "Invitation already exists for the given email, or user already\ \ had access to the tenant" security: - bearerAuth: [] - basicAuth: [] summary: Create an invitation tags: - Invitations x-internal: true /api/v1/{tenant}/invitations/email/{email}: get: description: Returns all invitations created for a given email address in the current tenant. operationId: listInvitationsByEmail parameters: - description: The email address of the invited explode: false in: path name: email required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/IAMInvitationController.ApiInvitationDetail" type: array description: listInvitationsByEmail 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve all invitations for a given email tags: - Invitations x-internal: true /api/v1/{tenant}/invitations/search: get: description: "Search and filter invitations by email, status, and pagination." operationId: searchInvitations parameters: - description: The email address of the invited explode: false in: query name: email required: false schema: nullable: true type: string style: form - description: The current status of the invitations explode: false in: query name: status required: false schema: allOf: - $ref: "#/components/schemas/Invitation.InvitationStatus" nullable: true style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMInvitationController.ApiInvitationDetail_" description: searchInvitations 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for invitations tags: - Invitations x-internal: true /api/v1/{tenant}/invitations/{id}: delete: description: Deletes the invitation by its ID. operationId: deleteInvitation parameters: - description: The id of the invitation explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: Invitation successfully deleted "404": description: Invitation not found security: - bearerAuth: [] - basicAuth: [] summary: Delete an invitation tags: - Invitations x-internal: true get: description: "Retrieves the invitation by its ID, including the invitation link." operationId: invitation parameters: - description: The id of the invitation explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMInvitationController.ApiInvitationDetail" description: getInvitation 200 response "404": description: Invitation not found security: - bearerAuth: [] - basicAuth: [] summary: Retrieve an invitation tags: - Invitations x-internal: true /api/v1/{tenant}/kv: get: operationId: listAllKeys parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_KVEntry_" description: listAllKeys 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all keys tags: - KV x-internal: false /api/v1/{tenant}/logs/search: get: operationId: searchLogs parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_LogEntry_" description: searchLogs 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for logs tags: - Logs x-internal: true /api/v1/{tenant}/logs/{executionId}: delete: operationId: deleteLogsFromExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The min log level filter explode: false in: query name: minLevel required: false schema: allOf: - $ref: "#/components/schemas/Level" nullable: true style: form - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The task id explode: false in: query name: taskId required: false schema: nullable: true type: string style: form - description: The attempt number explode: false in: query name: attempt required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteLogsFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Delete logs for a specific execution, taskrun or task" tags: - Logs x-internal: true get: operationId: listLogsFromExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The min log level filter explode: false in: query name: minLevel required: false schema: allOf: - $ref: "#/components/schemas/Level" nullable: true style: form - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The task id explode: false in: query name: taskId required: false schema: nullable: true type: string style: form - description: The attempt number explode: false in: query name: attempt required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/LogEntry" type: array description: listLogsFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Get logs for a specific execution, taskrun or task" tags: - Logs x-internal: true /api/v1/{tenant}/logs/{executionId}/download: get: operationId: downloadLogsFromExecution parameters: - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The min log level filter explode: false in: query name: minLevel required: false schema: allOf: - $ref: "#/components/schemas/Level" nullable: true style: form - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The task id explode: false in: query name: taskId required: false schema: nullable: true type: string style: form - description: The attempt number explode: false in: query name: attempt required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/plain: schema: format: binary type: string description: downloadLogsFromExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Download logs for a specific execution, taskrun or task" tags: - Logs x-internal: true /api/v1/{tenant}/logs/{namespace}/{flowId}: delete: operationId: deleteLogsFromFlow parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow identifier explode: false in: path name: flowId required: true schema: type: string style: simple - description: The trigger id explode: false in: query name: triggerId required: true schema: type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteLogsFromFlow 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Delete logs for a specific execution, taskrun or task" tags: - Logs x-internal: true /api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{metric}: get: operationId: aggregateMetricsFromFlow parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow Id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The metric name explode: false in: path name: metric required: true schema: type: string style: simple - description: "The start datetime, default to now - 30 days" explode: true in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: "The end datetime, default to now" explode: true in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: "The type of aggregation: avg, sum, min or max" explode: false in: query name: aggregation required: true schema: default: sum type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/MetricAggregations" description: aggregateMetricsFromFlow 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get metrics aggregations for a specific flow tags: - Metrics x-internal: true /api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{taskId}/{metric}: get: operationId: aggregateMetricsFromTask parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow Id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The task Id explode: false in: path name: taskId required: true schema: type: string style: simple - description: The metric name explode: false in: path name: metric required: true schema: type: string style: simple - description: "The start datetime, default to now - 30 days" explode: true in: query name: startDate required: false schema: format: date-time nullable: true type: string style: form - description: "The end datetime, default to now" explode: true in: query name: endDate required: false schema: format: date-time nullable: true type: string style: form - description: "The type of aggregation: avg, sum, min or max" explode: false in: query name: aggregation required: true schema: default: sum type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/MetricAggregations" description: aggregateMetricsFromTask 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get metrics aggregations for a specific flow tags: - Metrics x-internal: true /api/v1/{tenant}/metrics/names/{namespace}/{flowId}: get: operationId: listFlowMetrics parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow Id explode: false in: path name: flowId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: listFlowMetrics 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get metrics names for a specific flow tags: - Metrics x-internal: true /api/v1/{tenant}/metrics/names/{namespace}/{flowId}/{taskId}: get: operationId: listTaskMetrics parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow Id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The task Id explode: false in: path name: taskId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: listTaskMetrics 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get metrics names for a specific task in a flow tags: - Metrics x-internal: true /api/v1/{tenant}/metrics/tasks/{namespace}/{flowId}: get: operationId: listTasksWithMetrics parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow Id explode: false in: path name: flowId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: listTasksWithMetrics 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Get tasks id that have metrics for a specific flow, include deleted\ \ or renamed tasks" tags: - Metrics x-internal: true /api/v1/{tenant}/metrics/{executionId}: get: operationId: searchByExecution parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The execution id explode: false in: path name: executionId required: true schema: type: string style: simple - description: The taskrun id explode: false in: query name: taskRunId required: false schema: nullable: true type: string style: form - description: The task id explode: false in: query name: taskId required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_MetricEntry_" description: searchByExecution 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get metrics for a specific execution tags: - Metrics x-internal: true /api/v1/{tenant}/namespaces: post: operationId: createNamespace parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Namespace" description: The namespace required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Namespace" description: createNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a namespace tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/autocomplete: post: description: "Returns a list of namespaces for use in autocomplete fields, optionally\ \ allowing to filter by query and ids. Used especially for binding creation." operationId: autocompleteNamespaces parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiAutocomplete" required: true responses: "200": content: application/json: schema: items: type: string type: array description: autocompleteNamespaces 200 response security: - bearerAuth: [] - basicAuth: [] summary: List namespaces for autocomplete tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/search: get: operationId: searchNamespaces parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Return only existing namespace explode: false in: query name: existing required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Namespace_" description: searchNamespaces 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for namespaces tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{id}: delete: operationId: deleteNamespace parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: On success security: - bearerAuth: [] - basicAuth: [] summary: Delete a namespace tags: - Namespaces x-internal: false get: operationId: namespace parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Namespace" description: getNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get a namespace tags: - Namespaces x-internal: false put: operationId: updateNamespace parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Namespace" description: The namespace required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Namespace" description: updateNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a namespace tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{id}/inherited-plugindefaults: get: operationId: inheritedPluginDefaults parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/NamespaceController.ApiInheritedPluginDefaultFromNamespace" type: array description: inheritedPluginDefaults 200 response security: - bearerAuth: [] - basicAuth: [] summary: List inherited plugin defaults tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{id}/inherited-variables: get: operationId: inheritedVariables parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: additionalProperties: type: object type: object description: inheritedVariables 200 response security: - bearerAuth: [] - basicAuth: [] summary: List inherited variables tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{id}/plugindefaults/export: post: operationId: exportPluginDefaults parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportPluginDefaults 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export this namespace plugin defaults tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{id}/plugindefaults/import: post: operationId: importPluginDefaults parameters: - description: The namespace id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: fileUpload: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/importPluginDefaults_request" required: true responses: "200": content: application/json: schema: items: type: string type: array description: importPluginDefaults 200 response security: - bearerAuth: [] - basicAuth: [] summary: Import plugin defaults in this namespace tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{namespace}/dependencies: get: operationId: flowDependenciesFromNamespace parameters: - description: The flow namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: "if true, list only destination dependencies, otherwise list\ \ also source dependencies" explode: false in: query name: destinationOnly required: true schema: default: false type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FlowTopologyGraph" description: getFlowDependenciesFromNamespace 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve flow dependencies tags: - Flows x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files: delete: operationId: deleteFileDirectory parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri of the file / directory to delete explode: false in: query name: path required: true schema: type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteFileDirectory 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a file or directory tags: - Files x-internal: false get: operationId: fileContent parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: true schema: type: string style: form - description: "The revision, if not provided, the latest revision will be returned" explode: false in: query name: revision required: false schema: format: int32 nullable: true type: integer style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: binary type: string description: getFileContent 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get namespace file content tags: - Files x-internal: false post: operationId: createNamespaceFile parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: true schema: type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: multipart/form-data: encoding: fileContent: contentType: application/octet-stream explode: false style: form schema: $ref: "#/components/schemas/createNamespaceFile_request" required: true responses: "200": description: createNamespaceFile 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a file tags: - Files x-internal: false put: operationId: moveFileDirectory parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri to move from explode: false in: query name: from required: true schema: format: uri type: string style: form - description: The internal storage uri to move to explode: false in: query name: to required: true schema: format: uri type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: moveFileDirectory 200 response security: - bearerAuth: [] - basicAuth: [] summary: Move a file or directory tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files/directory: get: operationId: listNamespaceDirectoryFiles parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/FileAttributes" type: array description: listNamespaceDirectoryFiles 200 response security: - bearerAuth: [] - basicAuth: [] summary: List directory content tags: - Files x-internal: false post: operationId: createNamespaceDirectory parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: createNamespaceDirectory 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a directory tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files/export: get: operationId: exportNamespaceFiles parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: byte type: string description: exportNamespaceFiles 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export namespace files as a ZIP tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files/revisions: get: operationId: fileRevisions parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/NamespaceFileRevision" type: array description: getFileRevisions 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get namespace file revisions tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files/search: get: operationId: searchNamespaceFiles parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The string the file path should contain explode: false in: query name: q required: true schema: type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: type: string type: array description: searchNamespaceFiles 200 response security: - bearerAuth: [] - basicAuth: [] summary: Find files which path contain the given string in their URI tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/files/stats: get: operationId: fileMetadatas parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The internal storage uri explode: false in: query name: path required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/FileAttributes" description: getFileMetadatas 200 response security: - bearerAuth: [] - basicAuth: [] summary: "Get namespace file stats such as size, creation & modification dates\ \ and type" tags: - Files x-internal: false /api/v1/{tenant}/namespaces/{namespace}/inherited-secrets: get: operationId: inheritedSecrets parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: additionalProperties: items: type: string type: array type: object description: getInheritedSecrets 200 response security: - bearerAuth: [] - basicAuth: [] summary: List inherited secrets tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{namespace}/kv: delete: operationId: deleteKeyValues parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/KVController.ApiDeleteBulkRequest" description: The keys required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/KVController.ApiDeleteBulkResponse" description: deleteKeyValues 200 response security: - bearerAuth: [] - basicAuth: [] summary: Bulk-delete multiple key/value pairs from the given namespace. tags: - KV x-internal: false get: deprecated: true operationId: listKeys parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/KVEntry" type: array description: listKeys 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all keys for a namespace tags: - KV x-internal: false /api/v1/{tenant}/namespaces/{namespace}/kv/inheritance: get: operationId: listKeysWithInheritence parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/KVEntry" type: array description: listKeysWithInheritence 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all keys for inherited namespaces tags: - KV x-internal: false /api/v1/{tenant}/namespaces/{namespace}/kv/{key}: delete: operationId: deleteKeyValue parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The key explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: boolean description: deleteKeyValue 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a key-value pair tags: - KV x-internal: false get: operationId: keyValue parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The key explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/KVController.KvDetail" description: getKeyValue 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get value for a key tags: - KV x-internal: false put: operationId: setKeyValue parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The key explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: text/plain: schema: type: string description: The value of the key required: true responses: "200": description: setKeyValue 200 response security: - bearerAuth: [] - basicAuth: [] summary: Puts a key-value pair in store tags: - KV x-internal: false /api/v1/{tenant}/namespaces/{namespace}/secrets: get: deprecated: true operationId: listNamespaceSecrets parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/ApiSecretListResponse_ApiSecretMeta_" description: listNamespaceSecrets 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get secrets for a namespace tags: - Namespaces x-internal: false put: operationId: putSecrets parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiSecretValue" required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ApiSecretMetaEE" type: array description: putSecrets 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update secrets for a namespace tags: - Namespaces x-internal: false /api/v1/{tenant}/namespaces/{namespace}/secrets/{key}: delete: operationId: deleteSecret parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The secret key explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteSecret 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a secret for a namespace tags: - Namespaces x-internal: false patch: operationId: patchSecret parameters: - description: The namespace id explode: false in: path name: namespace required: true schema: type: string style: simple - description: The secret key explode: false in: path name: key required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiSecretMetaEE" required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ApiSecretMetaEE" type: array description: patchSecret 200 response security: - bearerAuth: [] - basicAuth: [] summary: Patch a secret metadata for a namespace tags: - Namespaces x-internal: false /api/v1/{tenant}/roles: post: operationId: createRole parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMRoleController.ApiRoleCreateOrUpdateRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMRoleController.ApiRoleDetail" description: Role successfully created "403": description: Insufficient privileges to create the role security: - bearerAuth: [] - basicAuth: [] summary: Create a role tags: - Roles x-internal: false /api/v1/{tenant}/roles/autocomplete: post: operationId: autocompleteRoles parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiAutocomplete" description: Autocomplete request required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ApiRoleSummary" type: array description: autocompleteRoles 200 response security: - bearerAuth: [] - basicAuth: [] summary: List roles for autocomplete tags: - Roles x-internal: false /api/v1/{tenant}/roles/ids: post: operationId: listRolesFromGivenIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/ApiIds" description: The ids that must be present on results required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/Role" type: array description: listRolesFromGivenIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: List roles by ids tags: - Roles x-internal: false /api/v1/{tenant}/roles/search: get: operationId: searchRoles parameters: - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_ApiRoleSummary_" description: searchRoles 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for roles tags: - Roles x-internal: false /api/v1/{tenant}/roles/{id}: delete: operationId: deleteRole parameters: - description: The role id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: On success security: - bearerAuth: [] - basicAuth: [] summary: Delete a role tags: - Roles x-internal: false get: operationId: role parameters: - description: The role id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMRoleController.ApiRoleDetail" description: getRole 200 response "404": description: Role not found security: - bearerAuth: [] - basicAuth: [] summary: Retrieve a role tags: - Roles x-internal: false put: operationId: updateRole parameters: - description: The role id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMRoleController.ApiRoleCreateOrUpdateRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMRoleController.ApiRoleDetail" description: Role successfully updated "403": description: Insufficient privileges to update the role "404": description: Role not found security: - bearerAuth: [] - basicAuth: [] summary: Update a role tags: - Roles x-internal: false /api/v1/{tenant}/secrets: get: operationId: listSecrets parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/ApiSecretListResponse_ApiSecretMeta_" description: listSecrets 200 response summary: Search secrets of all namespaces tags: - Secrets x-internal: true /api/v1/{tenant}/security-integrations: get: description: Superadmin-only. operationId: listSecurityIntegrations parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: listSecurityIntegrations 200 response security: - bearerAuth: [] - basicAuth: [] summary: List all security integrations tags: - SecurityIntegrations x-internal: true post: description: Superadmin-only. operationId: createSecurityIntegration parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSecurityIntegrationRequest" description: The security integration definition required: true responses: "200": content: application/json: schema: type: object description: createSecurityIntegration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create a security integration tags: - SecurityIntegrations x-internal: true /api/v1/{tenant}/security-integrations/{id}: delete: description: Superadmin-only. operationId: deleteSecurityIntegration parameters: - description: The ID of security integration explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteSecurityIntegration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a security integration tags: - SecurityIntegrations x-internal: true get: description: Superadmin-only. operationId: securityIntegration parameters: - description: The ID of security integration explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: getSecurityIntegration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve a security integration tags: - SecurityIntegrations x-internal: true /api/v1/{tenant}/security-integrations/{id}/disable: post: description: Superadmin-only. Disables the specified integration. operationId: disableSecurityIntegration parameters: - description: The ID of security integration explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: disableSecurityIntegration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable a security integration tags: - SecurityIntegrations x-internal: true /api/v1/{tenant}/security-integrations/{id}/enable: post: description: Superadmin-only. Enables the specified integration. operationId: enableSecurityIntegration parameters: - description: The ID of security integration explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: enableSecurityIntegration 200 response security: - bearerAuth: [] - basicAuth: [] summary: Enable a security integration tags: - SecurityIntegrations x-internal: true /api/v1/{tenant}/service-accounts: post: operationId: createServiceAccountForTenant parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountRequest" description: The service account required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountResponse" description: Service account successfully created "404": description: Group not found security: - bearerAuth: [] - basicAuth: [] summary: Create a service account for the given tenant tags: - ServiceAccount x-internal: false /api/v1/{tenant}/service-accounts/{id}: delete: operationId: deleteServiceAccountForTenant parameters: - description: The service account id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": description: deleteServiceAccountForTenant 200 response "404": description: Service account security: - bearerAuth: [] - basicAuth: [] summary: Delete a service account tags: - ServiceAccount x-internal: false get: operationId: serviceAccountForTenant parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountResponse" description: getServiceAccountForTenant 200 response "404": description: Service account not found security: - bearerAuth: [] - basicAuth: [] summary: Retrieve a service account tags: - ServiceAccount x-internal: false put: operationId: updateServiceAccount parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountRequest" description: The user required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountResponse" description: updateServiceAccount 200 response "404": description: "Service account, or group not found" security: - bearerAuth: [] - basicAuth: [] summary: Update a user service account tags: - ServiceAccount x-internal: false /api/v1/{tenant}/service-accounts/{id}/api-tokens: get: operationId: listApiTokensForServiceAccountWithTenant parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: listApiTokensForServiceAccountWithTenant 200 response security: - bearerAuth: [] - basicAuth: [] summary: List API tokens for a specific service account tags: - ServiceAccount x-internal: false post: operationId: createApiTokensForServiceAccountWithTenant parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApiTokenRequest" description: The create api-token request required: true responses: "200": content: application/json: schema: type: object description: createApiTokensForServiceAccountWithTenant 200 response security: - bearerAuth: [] - basicAuth: [] summary: Create new API Token for a specific service account tags: - ServiceAccount x-internal: false /api/v1/{tenant}/service-accounts/{id}/api-tokens/{tokenId}: delete: operationId: deleteApiTokenForServiceAccountWithTenant parameters: - description: The user id explode: false in: path name: id required: true schema: type: string style: simple - description: The token id explode: false in: path name: tokenId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteApiTokenForServiceAccountWithTenant 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete an API Token for specific service account and token id tags: - ServiceAccount x-internal: false /api/v1/{tenant}/stats/generate-reports: get: operationId: generate parameters: - description: The start date explode: true in: query name: from required: false schema: format: date nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/octet-stream: schema: format: byte type: string description: generate 200 response security: - bearerAuth: [] - basicAuth: [] tags: - Misc x-internal: false /api/v1/{tenant}/tenant-access: get: operationId: listTenantAccess parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The type of user explode: false in: query name: type required: false schema: allOf: - $ref: "#/components/schemas/UserType" nullable: true style: form - description: Filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_IAMTenantAccessController.ApiUserTenantAccess_" description: listTenantAccess 200 response security: - bearerAuth: [] - basicAuth: [] summary: Retrieve users belonging to the tenant tags: - Tenant Access x-internal: true post: description: Grants tenant access permissions to a user identified by email operationId: createTenantAccess parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMTenantAccessController.ApiCreateTenantAccessRequest" required: true responses: "204": description: Access successfully created "404": description: User not found "409": description: User already has access to the tenant security: - bearerAuth: [] - basicAuth: [] summary: Create tenant access for a user tags: - Tenant Access x-internal: true /api/v1/{tenant}/tenant-access/autocomplete: post: operationId: autocompleteUsers parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMTenantAccessController.UserApiAutocomplete" description: Autocomplete request required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiUserTenantAccess" type: array description: autocompleteUsers 200 response security: - bearerAuth: [] - basicAuth: [] summary: List users for autocomplete tags: - Users x-internal: false /api/v1/{tenant}/tenant-access/{userId}: delete: description: Removes tenant access permissions for the specified user operationId: deleteTenantAccess parameters: - description: The user id explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "204": description: Access successfully deleted "404": description: "User, or tenant access not found" security: - bearerAuth: [] - basicAuth: [] summary: Delete tenant access for a user tags: - Tenant Access x-internal: true get: description: Fetches the tenant access configuration for a given user operationId: tenantAccess parameters: - description: The user id explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/IAMTenantAccessController.ApiTenantAccess" description: Tenant access successfully retrieved "404": description: "User, or tenant access not found" security: - bearerAuth: [] - basicAuth: [] summary: Retrieve tenant access for a user tags: - Tenant Access x-internal: true put: description: Grants tenant access permissions to a user identified by userId operationId: createTenantAccess_1 parameters: - description: The user id explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "201": description: Access successfully created "404": description: User not found security: - bearerAuth: [] - basicAuth: [] summary: Create tenant access for a user tags: - Tenant Access x-internal: true /api/v1/{tenant}/tests: post: description: Creates a new test from a YAML definition. Requires TEST permission with the CREATE action. operationId: createTestSuite parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The TestSuite source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuite" description: createTestSuite 200 response summary: Create a test from YAML source tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/by-ids: delete: description: Deletes a test by namespace and ID. Requires TEST permission with the DELETE action. operationId: deleteTestSuitesByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.TestSuiteBulkRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: deleteTestSuitesByIds 200 response summary: Delete multiple tests by id tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/disable/by-ids: post: description: Disable a test by namespace and ID. Requires TEST permission with the UPDATE action. operationId: disableTestSuitesByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.TestSuiteBulkRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: disableTestSuitesByIds 200 response summary: Disable multiple tests by id tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/enable/by-ids: post: description: Enable a test by namespace and ID. Requires TEST permission with the UPDATE action. operationId: enableTestSuitesByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.TestSuiteBulkRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/BulkResponse" description: enableTestSuitesByIds 200 response summary: Enable multiple tests by id tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/results/search: get: description: "with optional filtering by namespace, test suite ID and flow ID.\ \ Requires TEST permission with the READ action." operationId: searchTestSuitesResults parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The test suite id to filter on explode: false in: query name: testSuiteId required: false schema: nullable: true type: string style: form - description: The namespace to filter on explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: The flow id to filter on explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_TestSuiteRunResult_" description: searchTestSuitesResults 200 response summary: Search for tests results tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/results/search/last: post: description: Get multiple tests last result for a query. operationId: testsLastResult parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.SearchTestsLastResult" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.TestsLastResultResponse" description: getTestsLastResult 200 response summary: Get tests last result tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/results/{id}: get: description: Get a test result once it was run. operationId: testResult parameters: - description: The test run ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuiteRunResult" description: getTestResult 200 response summary: Get a test result tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/run: post: description: Executes all TestSuites impacted by the specified filter. Requires TEST permission with the CREATE action. operationId: runTestSuitesByQuery parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteService.RunByQueryRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuiteService.TestRunByQueryResult" description: runTestSuitesByQuery 200 response summary: Run multiple TestSuites by query tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/search: get: description: Searches for tests with optional filtering by namespace and flow ID. Requires TEST permission with the READ action. operationId: searchTestSuites parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: The namespace to filter on explode: false in: query name: namespace required: false schema: nullable: true type: string style: form - description: The flow id to filter on explode: false in: query name: flowId required: false schema: nullable: true type: string style: form - description: Include child namespaces in filter or not explode: false in: query name: includeChildNamespaces required: true schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_TestSuite_" description: searchTestSuites 200 response summary: Search for tests tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/validate: post: description: Validates a test YAML definition without persisting it. Returns constraint violations if any. Requires TEST permission with the READ action. operationId: validateTestSuite parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The TestSuite source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ValidateConstraintViolation" description: validateTestSuite 200 response summary: Validate a test tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/{namespace}/{id}: delete: description: Deletes a test by namespace and ID. Requires TEST permission with the DELETE action. operationId: deleteTestSuite parameters: - description: The TestSuite namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The TestSuite ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteTestSuite 200 response summary: Delete a test tags: - TestSuites x-internal: false get: description: Retrieves a test by namespace and ID. Requires TEST permission with the READ action. operationId: testSuite parameters: - description: The TestSuite namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The TestSuite ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuite" description: getTestSuite 200 response summary: Retrieve a test tags: - TestSuites x-internal: false put: description: Updates an existing test with a new YAML definition. Requires TEST permission with the UPDATE action. operationId: updateTestSuite parameters: - description: The TestSuite namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The TestSuite ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/x-yaml: schema: type: string description: The TestSuite source code required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuite" description: updateTestSuite 200 response summary: Update a test from YAML source tags: - TestSuites x-internal: false /api/v1/{tenant}/tests/{namespace}/{id}/run: post: description: Executes all test cases in the specified test. Requires TEST permission with the CREATE action. operationId: runTestSuite parameters: - description: The TestSuite namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The TestSuite ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TestSuiteController.RunRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestSuiteRunResult" description: runTestSuite 200 response summary: Run a full test tags: - TestSuites x-internal: false /api/v1/{tenant}/triggers: put: operationId: updateTrigger parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Trigger" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Trigger" description: updateTrigger 200 response security: - bearerAuth: [] - basicAuth: [] summary: Update a trigger tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/delete: post: operationId: deleteBackfill parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Trigger" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Trigger" description: deleteBackfill 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a backfill tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/delete/by-query: post: operationId: deleteBackfillByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteBackfillByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/delete/by-triggers: post: operationId: deleteBackfillByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Trigger" type: array required: true responses: "200": content: application/json: schema: type: object description: deleteBackfillByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/pause: put: operationId: pauseBackfill parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Trigger" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Trigger" description: pauseBackfill 200 response security: - bearerAuth: [] - basicAuth: [] summary: Pause a backfill tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/pause/by-query: post: operationId: pauseBackfillByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: pauseBackfillByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Pause backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/pause/by-triggers: post: operationId: pauseBackfillByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Trigger" type: array required: true responses: "200": content: application/json: schema: type: object description: pauseBackfillByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Pause backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/unpause: put: operationId: unpauseBackfill parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/Trigger" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/Trigger" description: unpauseBackfill 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unpause a backfill tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/unpause/by-query: post: operationId: unpauseBackfillByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: unpauseBackfillByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unpause backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/backfill/unpause/by-triggers: post: operationId: unpauseBackfillByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Trigger" type: array required: true responses: "200": content: application/json: schema: type: object description: unpauseBackfillByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unpause backfill for given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/delete/by-query: delete: operationId: deleteTriggersByQuery parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/deleteTriggersByQuery_request" required: true responses: "200": content: application/json: schema: type: object description: deleteTriggersByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete triggers by query parameters tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/delete/by-triggers: delete: operationId: deleteTriggersByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Trigger" type: array required: true responses: "200": content: application/json: schema: type: object description: deleteTriggersByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/export/by-query/csv: get: operationId: exportTriggers parameters: - description: A list of filters explode: false in: query name: filters required: true schema: items: $ref: "#/components/schemas/QueryFilter" type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: text/csv: schema: items: type: object type: array description: exportTriggers 200 response security: - bearerAuth: [] - basicAuth: [] summary: Export all triggers as a streamed CSV file tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/search: get: operationId: searchTriggers parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_TriggerController.Triggers_" description: searchTriggers 200 response security: - bearerAuth: [] - basicAuth: [] summary: Search for triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/set-disabled/by-query: post: operationId: disabledTriggersByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - description: The disabled state explode: false in: query name: disabled required: true schema: default: true type: boolean style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: disabledTriggersByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable/enable triggers by query parameters tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/set-disabled/by-triggers: post: operationId: disabledTriggersByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/TriggerController.SetDisabledRequest" required: true responses: "200": content: application/json: schema: type: object description: disabledTriggersByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Disable/enable given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/unlock/by-query: post: operationId: unlockTriggersByQuery parameters: - description: Filters explode: false in: query name: filters required: false schema: items: $ref: "#/components/schemas/QueryFilter" nullable: true type: array style: form - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: unlockTriggersByQuery 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unlock triggers by query parameters tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/unlock/by-triggers: post: operationId: unlockTriggersByIds parameters: - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: "#/components/schemas/Trigger" type: array required: true responses: "200": content: application/json: schema: type: object description: unlockTriggersByIds 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unlock given triggers tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/{namespace}/{flowId}: get: operationId: searchTriggersForFlow parameters: - description: The current page explode: false in: query name: page required: true schema: default: 1 format: int32 minimum: 1 type: integer style: form - description: The current page size explode: false in: query name: size required: true schema: default: 10 format: int32 minimum: 1 type: integer style: form - description: The sort of current page explode: false in: query name: sort required: false schema: items: type: string nullable: true type: array style: form - description: A string filter explode: false in: query name: q required: false schema: nullable: true type: string style: form - description: The namespace explode: false in: path name: namespace required: true schema: nullable: true type: string style: simple - description: The flow id explode: false in: path name: flowId required: true schema: nullable: true type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagedResults_Trigger_" description: searchTriggersForFlow 200 response security: - bearerAuth: [] - basicAuth: [] summary: Get all triggers for a flow tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}: delete: operationId: deleteTrigger parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The trigger id explode: false in: path name: triggerId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: deleteTrigger 200 response security: - bearerAuth: [] - basicAuth: [] summary: Delete a trigger tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/restart: post: operationId: restartTrigger parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The trigger id explode: false in: path name: triggerId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: type: object description: restartTrigger 200 response security: - bearerAuth: [] - basicAuth: [] summary: Restart a trigger tags: - Triggers x-internal: false /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/unlock: post: operationId: unlockTrigger parameters: - description: The namespace explode: false in: path name: namespace required: true schema: type: string style: simple - description: The flow id explode: false in: path name: flowId required: true schema: type: string style: simple - description: The trigger id explode: false in: path name: triggerId required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: "#/components/schemas/Trigger" description: unlockTrigger 200 response security: - bearerAuth: [] - basicAuth: [] summary: Unlock a trigger tags: - Triggers x-internal: false /api/v1/{tenant}/users/{id}/groups: put: operationId: updateUserGroups parameters: - description: The user ID explode: false in: path name: id required: true schema: type: string style: simple - explode: false in: path name: tenant required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: "#/components/schemas/IAMUserGroupController.ApiUpdateUserGroupsRequest" required: true responses: "204": description: User's groups successfully updated "400": description: Invalid request payload "404": description: User or one of the groups not found security: - bearerAuth: [] - basicAuth: [] summary: Update the list of groups a user belongs to for the given tenant tags: - Users x-internal: false /login: post: operationId: login requestBody: content: application/x-www-form-urlencoded: schema: $ref: "#/components/schemas/UsernamePasswordCredentials" application/json: schema: $ref: "#/components/schemas/UsernamePasswordCredentials" required: true responses: "200": content: application/json: schema: type: object description: login 200 response tags: - login x-internal: true components: schemas: AbstractFlow: properties: id: maxLength: 100 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string revision: format: int32 minimum: 1 type: integer updated: description: The timestamp when this revision was created or last updated. format: date-time type: string description: type: string inputs: items: $ref: "#/components/schemas/Input_Object_" type: array outputs: items: $ref: "#/components/schemas/Output" type: array disabled: type: boolean labels: items: $ref: "#/components/schemas/Label" type: array variables: additionalProperties: false type: object workerGroup: $ref: "#/components/schemas/WorkerGroup" deleted: type: boolean required: - deleted - disabled - id - namespace type: object AbstractGraph: example: uid: uid branchType: ERROR type: type properties: uid: type: string type: type: string branchType: $ref: "#/components/schemas/AbstractGraph.BranchType" type: object AbstractGraph.BranchType: enum: - ERROR - FINALLY - AFTER_EXECUTION type: string AbstractRetry: type: object AbstractTrigger: example: allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" title: A unique ID for the whole flow. type: string type: minLength: 1 pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" title: The class name for this current trigger. type: string version: description: | Defines the version of the plugin to use. The version must follow the Semantic Versioning (SemVer) specification: - A single-digit MAJOR version (e.g., `1`). - A MAJOR.MINOR version (e.g., `1.1`). - A MAJOR.MINOR.PATCH version, optionally with any qualifier (e.g., `1.1.2`, `1.1.0-SNAPSHOT`). title: Plugin Version type: string description: type: string conditions: items: $ref: "#/components/schemas/Condition" title: List of conditions in order to limit the flow trigger. type: array disabled: default: false type: boolean workerGroup: $ref: "#/components/schemas/WorkerGroup" logLevel: $ref: "#/components/schemas/Level" labels: $ref: "#/components/schemas/The_labels_to_pass_to_the_execution_created_" stopAfter: items: $ref: "#/components/schemas/State.Type" title: List of execution states after which a trigger should be stopped (a.k.a. disabled). type: array logToFile: type: boolean failOnTriggerError: type: boolean allowConcurrent: title: Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress. type: boolean assets: $ref: "#/components/schemas/AssetsDeclaration" required: - id - type type: object AbstractTriggerForExecution: example: id: id type: type version: version properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" title: A unique ID for the whole flow. type: string type: minLength: 1 pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" title: The class name for this current trigger. type: string version: description: | Defines the version of the plugin to use. The version must follow the Semantic Versioning (SemVer) specification: - A single-digit MAJOR version (e.g., `1`). - A MAJOR.MINOR version (e.g., `1.1`). - A MAJOR.MINOR.PATCH version, optionally with any qualifier (e.g., `1.1.2`, `1.1.0-SNAPSHOT`). title: Plugin Version type: string required: - id - type type: object AbstractUser: properties: type: $ref: "#/components/schemas/UserType" groupList: items: $ref: "#/components/schemas/GroupIdentifier" type: array groups: items: type: object type: array username: type: string email: pattern: "^$|^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$" type: string superAdmin: type: boolean id: type: string name: type: string description: type: string firstName: type: string lastName: type: string providers: items: $ref: "#/components/schemas/AbstractUser.TenantIdentityProvider" type: array required: - email - type - username type: object AbstractUser.TenantIdentityProvider: allOf: - $ref: "#/components/schemas/IdentityProvider" - properties: tenantId: nullable: true type: string type: object type: object Action: enum: - READ - CREATE - UPDATE - DELETE type: string AiController.AiProviderResponse: properties: id: type: string displayName: type: string isDefault: type: boolean type: object ApiAuth: properties: uid: type: string type: type: string name: type: string type: object ApiAutocomplete: example: q: q existingOnly: true ids: - ids - ids properties: q: nullable: true type: string ids: items: type: string nullable: true type: array existingOnly: type: boolean type: object ApiGroupSummary: example: name: name id: id properties: id: type: string name: type: string type: object ApiIds: example: ids: - ids - ids properties: ids: items: type: string type: array type: object ApiPatchSuperAdminRequest: example: superAdmin: true properties: superAdmin: type: boolean required: - superAdmin type: object ApiRoleSummary: example: isDefault: true name: name id: id isManaged: true properties: id: type: string name: type: string isDefault: type: boolean isManaged: type: boolean type: object ApiSecretListResponse_ApiSecretMeta_: example: total: 0 readOnly: true results: - namespace: namespace description: description key: key tags: - value: value key: key - value: value key: key - namespace: namespace description: description key: key tags: - value: value key: key - value: value key: key properties: readOnly: type: boolean results: items: $ref: "#/components/schemas/ApiSecretMetaEE" type: array total: format: int64 type: integer required: - readOnly - results type: object ApiSecretMeta: properties: key: type: string required: - key type: object ApiSecretMetaEE: allOf: - $ref: "#/components/schemas/ApiSecretMeta" - properties: namespace: type: string description: type: string tags: items: $ref: "#/components/schemas/ApiSecretTag" type: array required: - tags type: object example: null example: namespace: namespace description: description key: key tags: - value: value key: key - value: value key: key type: object ApiSecretTag: example: value: value key: key properties: key: type: string value: type: string required: - key - value type: object ApiSecretValue: example: description: description value: value key: key tags: - value: value key: key - value: value key: key properties: tags: items: $ref: "#/components/schemas/ApiSecretTag" type: array key: minLength: 1 type: string value: minLength: 1 type: string description: type: string required: - key - value type: object ApiTenant: allOf: - $ref: "#/components/schemas/Tenant" - properties: deleted: type: boolean logo: type: string type: object required: - deleted type: object ApiTenantSummary: example: name: name id: id properties: id: type: string name: type: string type: object ApiToken: example: lastUsed: 2000-01-23T04:56:07.000+00:00 expired: true prefix: prefix name: name description: description id: id exp: 2000-01-23T04:56:07.000+00:00 iat: 2000-01-23T04:56:07.000+00:00 extended: true properties: id: type: string name: type: string description: type: string prefix: type: string iat: format: date-time type: string exp: format: date-time type: string lastUsed: format: date-time type: string extended: type: boolean expired: type: boolean type: object ApiTokenList: example: total: 0 results: - lastUsed: 2000-01-23T04:56:07.000+00:00 expired: true prefix: prefix name: name description: description id: id exp: 2000-01-23T04:56:07.000+00:00 iat: 2000-01-23T04:56:07.000+00:00 extended: true - lastUsed: 2000-01-23T04:56:07.000+00:00 expired: true prefix: prefix name: name description: description id: id exp: 2000-01-23T04:56:07.000+00:00 iat: 2000-01-23T04:56:07.000+00:00 extended: true properties: total: format: int32 type: integer results: items: $ref: "#/components/schemas/ApiToken" type: array type: object ApiUser: allOf: - $ref: "#/components/schemas/AbstractUser" - properties: auths: items: $ref: "#/components/schemas/ApiAuth" type: array type: object type: object AppGenerationPrompt: properties: conversationId: type: string userPrompt: type: string yaml: type: string providerId: type: string type: object AppsController.ApiApp: properties: uid: type: string id: type: string name: type: string type: type: string namespace: type: string flowId: type: string tags: items: type: string type: array enabled: type: boolean created: format: date-time type: string updated: format: date-time type: string type: object AppsController.ApiAppCatalogItem: properties: uid: type: string name: type: string description: type: string type: type: string tags: items: type: string type: array thumbnail: type: string type: object AppsController.ApiAppSource: properties: uid: type: string name: type: string namespace: type: string tags: items: type: string type: array disabled: type: boolean source: type: string created: format: date-time type: string updated: format: date-time type: string type: object AppsController.ApiAppTags: properties: tags: items: type: string type: array type: object AppsController.ApiBulkImportResponse: properties: success: items: type: string type: array errors: items: $ref: "#/components/schemas/AppsController.ApiBulkImportResponse.Error" type: array type: object AppsController.ApiBulkImportResponse.Error: properties: source: type: string message: type: string type: object AppsController.ApiBulkOperationRequest: properties: uids: items: type: string type: array type: object Assertion: example: isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 properties: value: $ref: "#/components/schemas/Property_Object_" taskId: type: string errorMessage: $ref: "#/components/schemas/Property_String_" description: $ref: "#/components/schemas/Property_String_" endsWith: $ref: "#/components/schemas/Property_String_" startsWith: $ref: "#/components/schemas/Property_String_" contains: $ref: "#/components/schemas/Property_String_" equalTo: $ref: "#/components/schemas/Property_Object_" notEqualTo: $ref: "#/components/schemas/Property_Object_" greaterThan: $ref: "#/components/schemas/Property_Double_" greaterThanOrEqualTo: $ref: "#/components/schemas/Property_Double_" lessThan: $ref: "#/components/schemas/Property_Double_" lessThanOrEqualTo: $ref: "#/components/schemas/Property_Double_" in: $ref: "#/components/schemas/Property_List_String__" notIn: $ref: "#/components/schemas/Property_List_String__" isNull: $ref: "#/components/schemas/Property_Boolean_" isNotNull: $ref: "#/components/schemas/Property_Boolean_" required: - value type: object AssertionResult: example: actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true properties: operator: type: string expected: type: object actual: type: object isSuccess: type: boolean taskId: type: string description: type: string errorMessage: type: string required: - actual - expected - isSuccess - operator type: object AssertionRunError: example: details: details message: message properties: message: type: string details: type: string required: - message type: object Asset: example: metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type properties: namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string id: maxLength: 150 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string type: minLength: 1 type: string displayName: type: string description: type: string metadata: additionalProperties: type: object type: object required: - id - type type: object AssetIdentifier: example: id: id type: type properties: id: type: string type: type: string type: object AssetTopologyGraph: properties: nodes: items: $ref: "#/components/schemas/AssetTopologyGraph.Node" type: array edges: items: $ref: "#/components/schemas/AssetTopologyGraph.Edge" type: array type: object AssetTopologyGraph.Edge: properties: source: type: string target: type: string relation: $ref: "#/components/schemas/Relation_1" type: object AssetTopologyGraph.Node: properties: uid: type: string namespace: type: string id: type: string type: $ref: "#/components/schemas/AssetTopologyGraph.Node.NodeType" required: - uid type: object AssetTopologyGraph.Node.NodeType: enum: - ASSET - FLOW type: string AssetsController.ApiAsset: properties: namespace: type: string id: type: string type: type: string displayName: type: string description: type: string metadata: additionalProperties: type: object type: object created: format: date-time type: string updated: format: date-time type: string deleted: type: boolean type: object AssetsController.ApiAssetLineageEvent: properties: uid: type: string namespace: type: string flowId: type: string flowRevision: format: int32 type: integer executionId: type: string taskId: type: string taskRunId: type: string state: type: string inputs: items: $ref: "#/components/schemas/AssetIdentifier" type: array outputs: items: $ref: "#/components/schemas/AssetIdentifier" type: array created: format: date-time type: string startDate: format: date-time type: string endDate: format: date-time type: string type: object AssetsController.ApiAssetUsage: properties: assetId: type: string namespace: type: string flowId: type: string flowRevision: format: int32 type: integer executionId: type: string taskId: type: string taskRunId: type: string created: format: date-time type: string type: object AssetsDeclaration: example: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true properties: enableAuto: $ref: "#/components/schemas/Property_Boolean_" inputs: $ref: "#/components/schemas/Property_List_AssetIdentifier__" outputs: $ref: "#/components/schemas/Property_List_Asset__" type: object AssetsInOut: properties: inputs: items: $ref: "#/components/schemas/AssetIdentifier" type: array outputs: items: $ref: "#/components/schemas/Asset" type: array type: object AttributeReference: properties: fullAttributeName: type: string fullyQualifiedAttributeName: type: string attributeBase: type: string urn: type: string attributeName: type: string subAttributeName: type: string type: object AuditLog: allOf: - $ref: "#/components/schemas/BaseAuditLog" - properties: appliedPatch: items: type: object type: array revertPatch: items: type: object type: array type: object type: object AuditLogController.ApiAuditLogItem: properties: auditLog: $ref: "#/components/schemas/AuditLog" user: $ref: "#/components/schemas/ApiUser" type: object AuditLogController.AuditLogDiff: properties: before: type: string after: type: string type: object AuditLogController.AuditLogOption: properties: id: type: string date: format: date-time type: string username: type: string type: object AuditLogController.FindRequest: properties: resource: $ref: "#/components/schemas/ResourceType" type: allOf: - $ref: "#/components/schemas/CrudEventType" nullable: true detail: additionalProperties: type: object type: object type: object AuditLogDetail: properties: permission: $ref: "#/components/schemas/Permission" resourceType: $ref: "#/components/schemas/ResourceType" type: type: string id: type: string required: - type type: object AuthController.Auth: properties: loginPassword: type: boolean mailsEnabled: type: boolean passwordless: type: boolean oauths: items: type: string type: array type: object AuthController.InvitationUserRequest: properties: firstName: type: string lastName: type: string password: type: string required: - firstName - lastName - password type: object AuthController.ResetPasswordRequest: properties: token: type: string password: type: string type: object Backfill: properties: start: format: date-time title: The start date. type: string end: format: date-time title: The end date. type: string currentDate: format: date-time title: The current date of the backfill being done. type: string paused: title: Whether the backfill is paused. type: boolean inputs: additionalProperties: type: object title: The inputs to pass to the backfilled executions. type: object labels: items: $ref: "#/components/schemas/Label" title: The labels to pass to the backfilled executions. type: array previousNextExecutionDate: format: date-time title: The nextExecutionDate before the backfill was created. type: string required: - start title: A backfill configuration. type: object Banner: example: endDate: 2000-01-23T04:56:07.000+00:00 tenantId: tenantId active: true id: id message: message type: INFO startDate: 2000-01-23T04:56:07.000+00:00 properties: id: type: string message: type: string type: $ref: "#/components/schemas/Banner.Type" startDate: format: date-time nullable: true type: string endDate: format: date-time nullable: true type: string tenantId: nullable: true type: string active: type: boolean required: - message type: object Banner.Type: enum: - INFO - WARNING - ERROR type: string BaseAuditLog: properties: tenantId: type: string id: type: string type: $ref: "#/components/schemas/CrudEventType" detail: $ref: "#/components/schemas/AuditLogDetail" date: format: date-time type: string userId: type: string ipAddress: type: string impersonatedBy: type: string required: - date - detail - id - type - userId type: object BaseResource_PatchRequest_: properties: schemas: items: type: string minItems: 1 type: array type: object BaseResource_ScimResource_: properties: schemas: items: type: string minItems: 1 type: array type: object BaseResource_SearchRequest_: properties: schemas: items: type: string minItems: 1 type: array type: object Binding: properties: id: type: string type: $ref: "#/components/schemas/Binding.Type" externalId: type: string roleId: type: string namespaceId: type: string deleted: type: boolean required: - deleted - externalId - roleId - type type: object Binding.Type: enum: - USER - GROUP type: string Blueprint: properties: id: type: string title: maxLength: 150 minLength: 1 type: string description: type: string tags: items: type: string type: array includedTasks: items: type: string type: array publishedAt: format: date-time type: string deleted: type: boolean template: $ref: "#/components/schemas/BlueprintTemplate" required: - deleted - title type: object BlueprintController.ApiBlueprintItem: properties: id: type: string title: type: string description: type: string includedTasks: items: type: string type: array tags: items: type: string type: array publishedAt: format: date-time type: string type: object BlueprintController.ApiBlueprintItemWithSource: allOf: - $ref: "#/components/schemas/BlueprintController.ApiBlueprintItem" - properties: source: type: string kind: $ref: "#/components/schemas/BlueprintController.Kind" type: object type: object BlueprintController.ApiBlueprintTagItem: properties: id: type: string name: type: string publishedAt: format: date-time type: string type: object BlueprintController.ApiFlowBlueprint: properties: id: type: string title: type: string description: type: string includedTasks: items: type: string type: array tags: items: type: string type: array source: type: string publishedAt: format: date-time type: string template: $ref: "#/components/schemas/BlueprintTemplate" type: object BlueprintController.FlowBlueprintCreateOrUpdate: properties: title: minLength: 1 type: string source: minLength: 1 type: string description: type: string tags: items: type: string type: array required: - source - title type: object BlueprintController.Kind: enum: - APP - DASHBOARD - FLOW type: string BlueprintController.UseBlueprintTemplateRequest: properties: templateArgumentsInputs: additionalProperties: type: object type: object type: object BlueprintController.UseBlueprintTemplateResponse: properties: generatedFlowSource: type: string type: object BlueprintTemplate: properties: source: minLength: 1 type: string templateArguments: additionalProperties: $ref: "#/components/schemas/Input_Object_" type: object required: - source type: object BlueprintWithFlowEntity: allOf: - $ref: "#/components/schemas/Blueprint" - properties: deleted: type: boolean flow: minLength: 1 type: string type: object required: - deleted - flow type: object Breakpoint: example: id: id value: value properties: id: type: string value: nullable: true type: string required: - id type: object BulkErrorResponse: example: invalids: "{}" message: message properties: message: type: string invalids: type: object type: object BulkResponse: example: count: 0 properties: count: format: int32 type: integer type: object Cache: example: ttl: ttl enabled: true properties: enabled: type: boolean ttl: type: string required: - enabled type: object ChartFiltersOverrides: properties: startDate: format: date-time type: string endDate: format: date-time type: string pageSize: format: int32 type: integer pageNumber: format: int32 type: integer namespace: type: string labels: additionalProperties: type: string type: object filters: items: $ref: "#/components/schemas/QueryFilter" type: array type: object Chart_ChartOption_: properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" type: string type: minLength: 1 pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" type: string chartOptions: type: object required: - id - type type: object Check: example: condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION properties: condition: minLength: 1 type: string message: minLength: 1 type: string style: $ref: "#/components/schemas/Check.Style" behavior: $ref: "#/components/schemas/Check.Behavior" required: - condition - message type: object Check.Behavior: enum: - BLOCK_EXECUTION - FAIL_EXECUTION - CREATE_EXECUTION type: string Check.Style: enum: - ERROR - SUCCESS - WARNING - INFO type: string Concurrency: example: limit: 1 behavior: QUEUE properties: limit: format: int32 minimum: 1 type: integer behavior: $ref: "#/components/schemas/Concurrency.Behavior" required: - behavior - limit type: object Concurrency.Behavior: enum: - QUEUE - CANCEL - FAIL type: string ConcurrencyLimit: example: running: 0 tenantId: tenantId namespace: namespace flowId: flowId properties: tenantId: type: string namespace: type: string flowId: type: string running: format: int32 type: integer required: - flowId - namespace - tenantId type: object Condition: example: type: type properties: type: pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" type: string required: - type type: object CreateApiTokenRequest: example: maxAge: maxAge name: name description: description extended: true properties: name: pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: type: string maxAge: type: string extended: type: boolean required: - name type: object CreateApiTokenResponse: example: fullToken: fullToken name: name id: id properties: id: type: string name: type: string fullToken: type: string type: object CreateSecurityIntegrationRequest: description: Create SecurityIntegration Request properties: name: description: The name of security integration. pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: description: The description of security integration. type: string type: $ref: "#/components/schemas/SecurityIntegration.Type" required: - description - name - type type: object CrudEventType: enum: - READ - CREATE - UPDATE - DELETE - LOGIN - LOGOUT - IMPERSONATE - LOGIN_FAILURE - ACCOUNT_LOCKED type: string Dashboard: properties: id: minLength: 1 type: string title: minLength: 1 type: string description: type: string timeWindow: $ref: "#/components/schemas/TimeWindow" charts: items: $ref: "#/components/schemas/Chart_ChartOption_" type: array required: - id - title type: object DashboardController.PreviewRequest: properties: chart: minLength: 1 type: string globalFilter: allOf: - $ref: "#/components/schemas/ChartFiltersOverrides" nullable: true required: - chart type: object DashboardGenerationPrompt: properties: conversationId: type: string userPrompt: type: string yaml: type: string providerId: type: string required: - conversationId - userPrompt type: object DependsOn: properties: inputs: items: type: string nullable: true type: array condition: nullable: true type: string type: object DocumentationWithSchema: properties: markdown: type: string schema: $ref: "#/components/schemas/PluginSchema" type: object EditionProvider.Edition: enum: - OSS - EE type: string Email: description: Scim core schema. properties: type: type: string value: type: string primary: type: boolean type: object EvaluationType: enum: - PASS - KILL - CANCEL - IGNORE type: string Event_ExecutionStatusEvent_: properties: data: $ref: "#/components/schemas/ExecutionStatusEvent" id: type: string name: type: string comment: type: string retry: type: string type: object Event_Execution_: properties: data: $ref: "#/components/schemas/Execution" id: type: string name: type: string comment: type: string retry: type: string type: object ExecutableTask.SubflowId: example: namespace: namespace flowId: flowId revision: 1 properties: namespace: type: string flowId: type: string revision: format: int32 nullable: true type: integer type: object Execution: example: outputs: "{}" variables: "{}" metadata: attemptNumber: 1 originalCreatedDate: 2000-01-23T04:56:07.000+00:00 inputs: "{}" kind: "" trigger: variables: key: "" logFile: https://openapi-generator.tech id: id type: type taskRunList: - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 parentId: parentId labels: - value: value key: key - value: value key: key fixtures: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value traceParent: traceParent flowRevision: 0 deleted: true namespace: namespace scheduleDate: 2000-01-23T04:56:07.000+00:00 id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 originalId: originalId breakpoints: - id: id value: value - id: id value: value flowId: flowId properties: labels: items: $ref: "#/components/schemas/Label" type: array id: type: string namespace: type: string flowId: type: string flowRevision: format: int32 type: integer taskRunList: items: $ref: "#/components/schemas/TaskRun" type: array inputs: type: object outputs: type: object variables: type: object state: $ref: "#/components/schemas/State" parentId: type: string originalId: type: string trigger: $ref: "#/components/schemas/ExecutionTrigger" deleted: type: boolean metadata: $ref: "#/components/schemas/ExecutionMetadata" scheduleDate: format: date-time nullable: true type: string traceParent: type: string fixtures: items: $ref: "#/components/schemas/TaskFixture" nullable: true type: array kind: allOf: - $ref: "#/components/schemas/ExecutionKind" nullable: true breakpoints: items: $ref: "#/components/schemas/Breakpoint" nullable: true type: array required: - deleted - flowId - flowRevision - id - namespace - state type: object ExecutionController.ExecutionResponse: allOf: - $ref: "#/components/schemas/Execution" - properties: deleted: type: boolean url: format: uri type: string type: object example: outputs: "{}" variables: "{}" metadata: attemptNumber: 1 originalCreatedDate: 2000-01-23T04:56:07.000+00:00 inputs: "{}" kind: "" trigger: variables: key: "" logFile: https://openapi-generator.tech id: id type: type taskRunList: - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 parentId: parentId url: https://openapi-generator.tech labels: - value: value key: key - value: value key: key fixtures: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value traceParent: traceParent flowRevision: 0 deleted: true namespace: namespace scheduleDate: 2000-01-23T04:56:07.000+00:00 id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 originalId: originalId breakpoints: - id: id value: value - id: id value: value flowId: flowId required: - deleted type: object ExecutionController.LastExecutionResponse: example: namespace: namespace id: id flowId: flowId startDate: 2000-01-23T04:56:07.000+00:00 status: CREATED properties: id: type: string flowId: type: string namespace: type: string startDate: format: date-time type: string status: $ref: "#/components/schemas/State.Type" type: object ExecutionController.SetLabelsByIdsRequest: properties: executionsId: items: type: string type: array executionLabels: items: $ref: "#/components/schemas/Label" type: array type: object ExecutionController.StateRequest: properties: taskRunId: type: string state: $ref: "#/components/schemas/State.Type" type: object ExecutionKind: enum: - NORMAL - TEST - PLAYGROUND type: string ExecutionMetadata: example: attemptNumber: 1 originalCreatedDate: 2000-01-23T04:56:07.000+00:00 properties: attemptNumber: format: int32 type: integer originalCreatedDate: format: date-time type: string type: object ExecutionRepositoryInterface.FlowFilter: properties: namespace: type: string id: type: string required: - id - namespace type: object ExecutionStatusEvent: properties: executionId: type: string tenantId: type: string namespace: type: string flowId: type: string state: $ref: "#/components/schemas/State" type: object ExecutionTrigger: example: variables: key: "" logFile: https://openapi-generator.tech id: id type: type properties: id: type: string type: type: string variables: additionalProperties: true type: object logFile: format: uri type: string required: - id - type type: object FileAttributes: example: fileName: fileName metadata: key: metadata lastModifiedTime: 0 creationTime: 6 size: 1 type: File properties: fileName: type: string lastModifiedTime: format: int64 type: integer creationTime: format: int64 type: integer type: $ref: "#/components/schemas/FileAttributes.FileType" size: format: int64 type: integer metadata: additionalProperties: type: string type: object type: object FileAttributes.FileType: enum: - File - Directory type: string x-enum-varnames: - File - Directory FileMetas: example: size: 0 properties: size: format: int64 type: integer required: - size type: object Filter: properties: filter: type: string expression: type: object type: object FilterExpression: type: object Fixtures: example: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value properties: inputs: additionalProperties: true type: object files: additionalProperties: type: string type: object tasks: items: $ref: "#/components/schemas/TaskFixture" type: array trigger: $ref: "#/components/schemas/TriggerFixture" type: object Flow: allOf: - $ref: "#/components/schemas/AbstractFlow" - properties: id: maxLength: 100 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string revision: format: int32 minimum: 1 type: integer description: type: string inputs: items: $ref: "#/components/schemas/Input_Object_" type: array disabled: type: boolean labels: items: $ref: "#/components/schemas/Label" type: array workerGroup: $ref: "#/components/schemas/WorkerGroup" deleted: type: boolean finally: items: $ref: "#/components/schemas/Task" type: array variables: $ref: "#/components/schemas/Flow_allOf_variables" tasks: additionalProperties: true items: $ref: "#/components/schemas/Task" minItems: 1 type: array errors: items: $ref: "#/components/schemas/Task" type: array afterExecution: items: $ref: "#/components/schemas/Task" type: array triggers: items: $ref: "#/components/schemas/AbstractTrigger" type: array pluginDefaults: items: $ref: "#/components/schemas/PluginDefault" type: array concurrency: $ref: "#/components/schemas/Concurrency" outputs: description: Output values make information about the execution of your Flow available and expose for other Kestra flows to use. Output values are similar to return values in programming languages. items: $ref: "#/components/schemas/Output" title: Output values available and exposes to other flows. type: array retry: $ref: "#/components/schemas/AbstractRetry" sla: items: $ref: "#/components/schemas/SLA" type: array checks: description: "A list of conditions that are evaluated before the flow\ \ is executed. If no checks are defined, the flow executes normally." items: $ref: "#/components/schemas/Check" title: Conditions evaluated before the flow is executed. type: array type: object example: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null required: - deleted - disabled - id - namespace - tasks type: object FlowController.TaskValidationType: enum: - TASKS - TRIGGERS type: string FlowForExecution: allOf: - $ref: "#/components/schemas/AbstractFlow" - properties: id: maxLength: 100 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string revision: format: int32 minimum: 1 type: integer description: type: string inputs: items: $ref: "#/components/schemas/Input_Object_" type: array outputs: items: $ref: "#/components/schemas/Output" type: array disabled: type: boolean labels: $ref: "#/components/schemas/Map_Object.Object_" variables: $ref: "#/components/schemas/Flow_allOf_variables" workerGroup: $ref: "#/components/schemas/WorkerGroup" deleted: type: boolean tasks: items: $ref: "#/components/schemas/TaskForExecution" minItems: 1 type: array errors: items: $ref: "#/components/schemas/TaskForExecution" type: array finally: items: $ref: "#/components/schemas/TaskForExecution" type: array afterExecution: items: $ref: "#/components/schemas/TaskForExecution" type: array triggers: items: $ref: "#/components/schemas/AbstractTriggerForExecution" type: array type: object example: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null description: description afterExecution: - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null triggers: - id: id type: type version: version - id: id type: type version: version revision: 1 labels: empty: true deleted: true namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null errors: - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null - inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null required: - deleted - disabled - id - namespace - tasks type: object FlowGenerationPrompt: properties: conversationId: type: string userPrompt: type: string yaml: type: string providerId: type: string namespace: type: string required: - conversationId - userPrompt type: object FlowGraph: example: nodes: - uid: uid branchType: ERROR type: type - uid: uid branchType: ERROR type: type flowables: - flowables - flowables edges: - source: source target: target relation: relationType: SEQUENTIAL value: value - source: source target: target relation: relationType: SEQUENTIAL value: value clusters: - cluster: uid: uid branchType: ERROR type: type nodes: - nodes - nodes start: start end: end parents: - parents - parents - cluster: uid: uid branchType: ERROR type: type nodes: - nodes - nodes start: start end: end parents: - parents - parents properties: nodes: items: $ref: "#/components/schemas/AbstractGraph" type: array edges: items: $ref: "#/components/schemas/FlowGraph.Edge" type: array clusters: items: $ref: "#/components/schemas/FlowGraph.Cluster" type: array flowables: items: type: string type: array type: object FlowGraph.Cluster: example: cluster: uid: uid branchType: ERROR type: type nodes: - nodes - nodes start: start end: end parents: - parents - parents properties: cluster: $ref: "#/components/schemas/AbstractGraph" nodes: items: type: string type: array parents: items: type: string type: array start: type: string end: type: string type: object FlowGraph.Edge: example: source: source target: target relation: relationType: SEQUENTIAL value: value properties: source: type: string target: type: string relation: $ref: "#/components/schemas/Relation" type: object FlowId: properties: id: type: string namespace: type: string revision: format: int32 type: integer tenantId: type: string type: object FlowInterface: allOf: - $ref: "#/components/schemas/FlowId" - $ref: "#/components/schemas/SoftDeletable_FlowInterface_" - $ref: "#/components/schemas/TenantInterface" - properties: description: type: string disabled: type: boolean deleted: type: boolean labels: items: $ref: "#/components/schemas/Label" type: array inputs: items: $ref: "#/components/schemas/Input_Object_" type: array outputs: items: $ref: "#/components/schemas/Output" type: array variables: additionalProperties: type: object type: object workerGroup: $ref: "#/components/schemas/WorkerGroup" concurrency: $ref: "#/components/schemas/Concurrency" sla: items: $ref: "#/components/schemas/SLA" type: array source: type: string type: object example: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: key: "{}" inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels source: source revision: 0 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true namespace: namespace tenantId: tenantId disabled: true id: id workerGroup: fallback: FAIL key: key type: object FlowNode: example: uid: uid namespace: namespace id: id properties: uid: type: string namespace: type: string id: type: string required: - uid type: object FlowRelation: enum: - FLOW_TASK - FLOW_TRIGGER type: string FlowTopologyGraph: example: nodes: - uid: uid namespace: namespace id: id - uid: uid namespace: namespace id: id edges: - source: source target: target relation: FLOW_TASK - source: source target: target relation: FLOW_TASK properties: nodes: items: $ref: "#/components/schemas/FlowNode" type: array edges: items: $ref: "#/components/schemas/FlowTopologyGraph.Edge" type: array type: object FlowTopologyGraph.Edge: example: source: source target: target relation: FLOW_TASK properties: source: type: string target: type: string relation: $ref: "#/components/schemas/FlowRelation" type: object FlowWithSource: allOf: - $ref: "#/components/schemas/Flow" - $ref: "#/components/schemas/AbstractFlow" - properties: id: maxLength: 100 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string revision: format: int32 minimum: 1 type: integer description: type: string inputs: items: $ref: "#/components/schemas/Input_Object_" type: array disabled: type: boolean labels: items: $ref: "#/components/schemas/Label" type: array workerGroup: $ref: "#/components/schemas/WorkerGroup" deleted: type: boolean variables: $ref: "#/components/schemas/Flow_allOf_variables" concurrency: $ref: "#/components/schemas/Concurrency" outputs: description: Output values make information about the execution of your Flow available and expose for other Kestra flows to use. Output values are similar to return values in programming languages. items: $ref: "#/components/schemas/Output" title: Output values available and exposes to other flows. type: array sla: items: $ref: "#/components/schemas/SLA" type: array source: type: string type: object example: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" source: source triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null required: - deleted - disabled - id - namespace type: object GroupIdentifier: properties: tenantId: nullable: true type: string groupId: type: string membership: $ref: "#/components/schemas/GroupIdentifier.Membership" managedExternally: type: boolean type: object GroupIdentifier.Membership: enum: - OWNER - MEMBER type: string IAMBindingController.ApiBindingDetail: properties: id: type: string type: $ref: "#/components/schemas/Binding.Type" namespace: nullable: true type: string role: $ref: "#/components/schemas/IAMBindingController.ApiRole" group: allOf: - $ref: "#/components/schemas/IAMBindingController.ApiBindingGroup" nullable: true user: allOf: - $ref: "#/components/schemas/IAMBindingController.ApiBindingUser" nullable: true type: object IAMBindingController.ApiBindingGroup: properties: id: type: string name: type: string type: object IAMBindingController.ApiBindingUser: properties: id: type: string username: type: string displayName: type: string type: $ref: "#/components/schemas/UserType" type: object IAMBindingController.ApiCreateBindingRequest: properties: type: $ref: "#/components/schemas/Binding.Type" externalId: type: string roleId: type: string namespaceId: nullable: true type: string required: - externalId - roleId - type type: object IAMBindingController.ApiRole: properties: id: type: string name: type: string type: object IAMGroupController.ApiCreateGroupRequest: properties: name: type: string description: type: string membersId: items: type: string type: array required: - name type: object IAMGroupController.ApiGroupDetail: example: name: name description: description id: id properties: id: type: string name: type: string description: type: string type: object IAMGroupController.ApiGroupMember: example: displayName: displayName groups: - external: true name: name id: id membership: OWNER - external: true name: name id: id membership: OWNER id: id username: username properties: id: type: string username: type: string displayName: type: string groups: items: $ref: "#/components/schemas/IAMGroupController.ApiGroupMembership" type: array type: object IAMGroupController.ApiGroupMembership: example: external: true name: name id: id membership: OWNER properties: id: type: string name: type: string external: type: boolean membership: $ref: "#/components/schemas/GroupIdentifier.Membership" type: object IAMGroupController.ApiUpdateGroupRequest: description: Represents updatable properties for a Group. properties: name: description: of the group. type: string description: description: of the group. type: string required: - name type: object IAMInvitationController.ApiInvitationCreateRequest: properties: createUserIfNotExist: type: boolean superAdmin: type: boolean roles: items: $ref: "#/components/schemas/IAMInvitationController.ApiInvitationRole" type: array groups: items: type: string type: array email: type: string required: - email type: object IAMInvitationController.ApiInvitationDetail: properties: id: type: string roles: items: $ref: "#/components/schemas/ApiRoleSummary" type: array groups: items: $ref: "#/components/schemas/ApiGroupSummary" type: array tenantId: type: string email: type: string status: $ref: "#/components/schemas/Invitation.InvitationStatus" sentAt: format: date-time type: string expiredAt: format: date-time type: string acceptedAt: format: date-time type: string superAdmin: type: boolean link: type: string type: object IAMInvitationController.ApiInvitationRole: properties: id: type: string namespaces: items: type: string type: array required: - id type: object IAMRoleController.ApiRoleCreateOrUpdateRequest: properties: permissions: $ref: "#/components/schemas/IAMRoleController_ApiRoleCreateOrUpdateRequest_permissions" name: type: string description: type: string isDefault: type: boolean required: - name - permissions type: object IAMRoleController.ApiRoleDetail: example: isDefault: true permissions: NAMESPACE: - NAMESPACE - NAMESPACE APPEXECUTION: - APPEXECUTION - APPEXECUTION APP: - APP - APP TENANT_ACCESS: - TENANT_ACCESS - TENANT_ACCESS SERVICE_ACCOUNT: - SERVICE_ACCOUNT - SERVICE_ACCOUNT AI_COPILOT: - AI_COPILOT - AI_COPILOT BLUEPRINT: - BLUEPRINT - BLUEPRINT FLOW: - FLOW - FLOW ROLE: - ROLE - ROLE GROUP: - GROUP - GROUP DASHBOARD: - DASHBOARD - DASHBOARD IMPERSONATE: - IMPERSONATE - IMPERSONATE TEMPLATE: - TEMPLATE - TEMPLATE AUDITLOG: - AUDITLOG - AUDITLOG SETTING: - SETTING - SETTING KVSTORE: - KVSTORE - KVSTORE EXECUTION: - EXECUTION - EXECUTION ASSET: - ASSET - ASSET USER: - USER - USER GROUP_MEMBERSHIP: - GROUP_MEMBERSHIP - GROUP_MEMBERSHIP INVITATION: - INVITATION - INVITATION TEST: - TEST - TEST CREDENTIAL: - CREDENTIAL - CREDENTIAL UNKNOWN: - UNKNOWN - UNKNOWN BINDING: - BINDING - BINDING SECRET: - SECRET - SECRET name: name description: description id: id isManaged: true properties: id: type: string name: type: string description: type: string permissions: $ref: "#/components/schemas/IAMRoleController_ApiRoleCreateOrUpdateRequest_permissions" isDefault: type: boolean isManaged: type: boolean type: object IAMServiceAccountController.ApiCreateServiceAccountRequest: description: Request payload for updating service account details properties: name: pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: type: string superAdmin: type: boolean tenants: items: type: string type: array required: - name type: object IAMServiceAccountController.ApiGroup: example: id: id properties: id: type: string type: object IAMServiceAccountController.ApiPatchServiceAccountRequest: description: Request payload for updating service account details properties: name: pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: type: string required: - name type: object IAMServiceAccountController.ApiServiceAccountDetail: description: A User Service Account. example: tenants: - name: name id: id - name: name id: id name: name description: description id: id superAdmin: true properties: id: description: the identifier of this service account. type: string name: description: the name of this service account. pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: description: the description of this service account. type: string tenants: items: $ref: "#/components/schemas/ApiTenantSummary" type: array superAdmin: type: boolean required: - name type: object IAMServiceAccountController.ApiServiceAccountRequest: description: A User Service Account. properties: groups: items: $ref: "#/components/schemas/IAMServiceAccountController.ApiGroup" type: array name: pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: type: string superAdmin: type: boolean required: - name type: object IAMServiceAccountController.ApiServiceAccountResponse: description: A User Service Account. example: name: name description: description groups: - id: id - id: id id: id superAdmin: true properties: id: description: the identifier of this service account. type: string name: description: the name of this service account. pattern: "^(?=.{1,63}$)[a-z0-9]+(?:-[a-z0-9]+)*$" type: string description: description: the description of this service account. type: string groups: items: $ref: "#/components/schemas/IAMServiceAccountController.ApiGroup" type: array superAdmin: type: boolean required: - name type: object IAMTenantAccessController.ApiAuthentication: example: name: name type: type properties: name: type: string type: type: string type: object IAMTenantAccessController.ApiCreateTenantAccessRequest: properties: email: type: string required: - email type: object IAMTenantAccessController.ApiGroup: example: external: true name: name id: id properties: id: type: string name: type: string external: type: boolean type: object IAMTenantAccessController.ApiRoleAssignment: properties: id: type: string name: type: string namespace: type: string origin: $ref: "#/components/schemas/RBACService.RoleAssignment.RoleOrigin" sourceId: type: string permissions: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiUserPermission" type: array type: object IAMTenantAccessController.ApiTenantAccess: properties: tenantId: type: string userId: type: string username: type: string displayName: type: string groups: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiGroup" type: array roles: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiRoleAssignment" type: array superAdmin: type: boolean type: object IAMTenantAccessController.ApiUserPermission: properties: permission: $ref: "#/components/schemas/Permission" actions: items: $ref: "#/components/schemas/Action" type: array type: object IAMTenantAccessController.ApiUserTenantAccess: example: displayName: displayName auths: - name: name type: type - name: name type: type description: description groups: - external: true name: name id: id - external: true name: name id: id id: id username: username properties: id: type: string username: type: string displayName: type: string description: type: string groups: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiGroup" type: array auths: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiAuthentication" type: array type: object IAMTenantAccessController.UserApiAutocomplete: allOf: - $ref: "#/components/schemas/ApiAutocomplete" - properties: username: nullable: true type: string type: object type: object IAMUserController.ApiCreateOrUpdateUserRequest: properties: tenants: items: type: string type: array groups: items: type: string type: array firstName: type: string lastName: type: string email: type: string password: type: string superAdmin: type: boolean restricted: type: boolean required: - email type: object IAMUserController.ApiGroup: example: tenantId: tenantId id: id properties: id: type: string tenantId: type: string type: object IAMUserController.ApiPatchRestrictedRequest: properties: restricted: type: boolean required: - restricted type: object IAMUserController.ApiPatchUserPasswordRequest: properties: password: type: string required: - password type: object IAMUserController.ApiUser: example: firstName: firstName lastName: lastName tenants: - name: name id: id - name: name id: id displayName: displayName auths: - name: name id: id type: type - name: name id: id type: type restricted: true groups: - tenantId: tenantId id: id - tenantId: tenantId id: id id: id superAdmin: true email: email username: username properties: id: type: string username: type: string displayName: type: string firstName: type: string lastName: type: string email: type: string tenants: items: $ref: "#/components/schemas/ApiTenantSummary" type: array auths: items: $ref: "#/components/schemas/IAMUserController.ApiUserAuth" type: array groups: items: $ref: "#/components/schemas/IAMUserController.ApiGroup" type: array superAdmin: type: boolean restricted: type: boolean type: object IAMUserController.ApiUserAuth: example: name: name id: id type: type properties: id: type: string name: type: string type: type: string type: object IAMUserController.ApiUserSummary: example: tenants: - name: name id: id - name: name id: id displayName: displayName auths: - name: name id: id type: type - name: name id: id type: type id: id superAdmin: true username: username properties: id: type: string username: type: string displayName: type: string tenants: items: $ref: "#/components/schemas/ApiTenantSummary" type: array auths: items: $ref: "#/components/schemas/IAMUserController.ApiUserAuth" type: array superAdmin: type: boolean type: object IAMUserGroupController.ApiUpdateUserGroupsRequest: properties: groupIds: items: type: string type: array type: object IdWithNamespace: example: namespace: namespace id: id properties: namespace: type: string id: type: string type: object IdentityProvider: properties: attributes: additionalProperties: type: object type: object externalId: type: string securityIntegrationId: type: string securityIntegrationName: type: string type: object InputType: properties: type: type: string cls: type: string type: object Input_Object_: example: dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][.a-zA-Z0-9_-]*" title: The ID of the input. type: string type: allOf: - $ref: "#/components/schemas/Type" title: The type of the input. description: title: The description of the input. type: string dependsOn: allOf: - $ref: "#/components/schemas/DependsOn" title: The dependencies of the input. required: type: boolean defaults: allOf: - $ref: "#/components/schemas/Property_Object_" title: The default value to use if no value is specified. prefill: allOf: - $ref: "#/components/schemas/Property_Object_" description: Optional UI hint for pre-filling the input. Cannot be used together with a default value. title: The suggested value for the input. displayName: title: The display name of the input. type: string required: - id - type type: object InstanceController.ApiActiveService: properties: type: $ref: "#/components/schemas/ServiceType" total: format: int64 type: integer type: object InstanceController.ApiActiveServiceList: properties: total: format: int32 type: integer services: items: $ref: "#/components/schemas/InstanceController.ApiActiveService" type: array type: object InstanceController.ApiCreateOrUpdateWorkerGroupRequest: description: ApiCreateWorkerGroupRequest. properties: key: description: The key of the worker group. type: string description: description: The description of the worker group. type: string allowedTenants: items: type: string type: array required: - key type: object InstanceController.ApiPluginArtifact: properties: title: type: string icon: type: string groupId: type: string artifactId: type: string versions: items: type: string type: array type: object InstanceController.ApiPluginArtifactList_PluginArtifact_: properties: total: format: int32 type: integer results: items: type: object type: array type: object InstanceController.ApiPluginArtifactList_PluginResolutionResult_: properties: total: format: int32 type: integer results: items: type: object type: array type: object InstanceController.ApiPluginListRequest: properties: plugins: items: type: string type: array type: object InstanceController.ApiPluginVersionDetails: properties: artifactId: type: string groupId: type: string version: type: string title: type: string description: type: string icon: type: string classes: items: $ref: "#/components/schemas/InstanceController.ApiPluginVersionDetails.ApiPluginClasses" type: array type: object InstanceController.ApiPluginVersionDetails.ApiPluginClass: properties: name: type: string icon: type: string type: object InstanceController.ApiPluginVersionDetails.ApiPluginClasses: properties: type: type: string classes: items: $ref: "#/components/schemas/InstanceController.ApiPluginVersionDetails.ApiPluginClass" type: array type: object InstanceController.ApiPluginVersions: properties: groupId: type: string artifactId: type: string versions: items: $ref: "#/components/schemas/InstanceController.ApiPluginVersions.ApiPluginVersionAndMetadata" type: array type: object InstanceController.ApiPluginVersions.ApiPluginVersionAndMetadata: properties: version: type: string metadata: $ref: "#/components/schemas/PluginArtifactMetadata" type: object InstanceController.ApiServerInstance: properties: id: type: string type: $ref: "#/components/schemas/ServerInstance.Type" version: type: string hostname: type: string type: object InstanceController.ApiServiceInstance: properties: id: type: string type: $ref: "#/components/schemas/ServiceType" state: $ref: "#/components/schemas/Service.ServiceState" server: $ref: "#/components/schemas/InstanceController.ApiServerInstance" createdAt: format: date-time type: string updatedAt: format: date-time type: string type: object InstanceController.ApiWorkerGroup: description: ApiWorkerGroup. properties: id: description: The ID of worker group. type: string key: description: The key of the worker group. type: string description: description: The description of the worker group. type: string allowedTenants: items: type: string type: array type: object InstanceController.ApiWorkerGroupDetails: description: ApiWorkerGroupDetails. properties: id: description: The ID of worker group. type: string key: description: The key of the worker group. type: string description: description: The description of the worker group. type: string allowedTenants: items: type: string type: array workers: description: The list of workers for the group. items: $ref: "#/components/schemas/ServiceInstance" type: array type: object InstanceController.ApiWorkerGroupItem: description: ApiWorkerGroup. properties: id: description: The ID of worker group. type: string key: description: The key of the worker group. type: string description: description: The description of the worker group. type: string activeWorkers: description: The number of active workers for the group. format: int32 type: integer type: object InstanceController.ApiWorkerGroupList: description: ApiWorkerGroupList. properties: workerGroups: description: The list of worker groups. items: $ref: "#/components/schemas/InstanceController.ApiWorkerGroupItem" type: array type: object Invitation: properties: isExpired: type: boolean email: pattern: "^$|^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$" type: string id: type: string bindings: items: $ref: "#/components/schemas/Binding" type: array groupIds: items: type: string type: array tenantId: type: string status: $ref: "#/components/schemas/Invitation.InvitationStatus" sentAt: format: date-time type: string expiredAt: format: date-time type: string acceptedAt: format: date-time type: string deleted: type: boolean userType: $ref: "#/components/schemas/UserType" superAdmin: type: boolean link: type: string required: - deleted - email type: object Invitation.InvitationStatus: enum: - PENDING - ACCEPTED - EXPIRED type: string Isolation: example: deniedServices: - EXECUTOR - EXECUTOR enabled: true properties: deniedServices: items: $ref: "#/components/schemas/ServiceType" type: array enabled: type: boolean type: object KVController.ApiDeleteBulkRequest: properties: keys: items: type: string type: array type: object KVController.ApiDeleteBulkResponse: example: keys: - keys - keys properties: keys: items: type: string type: array type: object KVController.KvDetail: example: type: STRING value: "{}" updated: 2000-01-23T04:56:07.000+00:00 revision: 0 properties: type: $ref: "#/components/schemas/KVType" value: type: object revision: format: int32 type: integer updated: format: date-time type: string type: object KVEntry: example: updateDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace description: description creationDate: 2000-01-23T04:56:07.000+00:00 version: 0 key: key expirationDate: 2000-01-23T04:56:07.000+00:00 properties: namespace: type: string key: type: string version: format: int32 type: integer description: nullable: true type: string creationDate: format: date-time type: string updateDate: format: date-time type: string expirationDate: format: date-time nullable: true type: string type: object KVType: enum: - STRING - NUMBER - BOOLEAN - DATETIME - DATE - DURATION - JSON type: string KillSwitch: example: evaluationType: PASS executionIds: - executionIds - executionIds deleted: true endDate: 2000-01-23T04:56:07.000+00:00 name: name tenantId: tenantId namespace: namespace description: description id: id flowId: flowId startDate: 2000-01-23T04:56:07.000+00:00 enabled: true properties: id: type: string name: type: string tenantId: type: string namespace: type: string flowId: type: string executionIds: items: type: string type: array startDate: format: date-time type: string endDate: format: date-time type: string description: type: string evaluationType: $ref: "#/components/schemas/EvaluationType" enabled: type: boolean deleted: type: boolean required: - evaluationType - name - startDate type: object Label: description: A key/value pair that can be attached to a Flow or Execution. Labels are often used to organize and categorize objects. example: value: value key: key properties: key: minLength: 1 pattern: "^[\\p{Ll}][\\p{L}0-9._-]*$" type: string x-pattern-message: Invalid label key. A valid key contains only lowercase letters numbers hyphens (-) underscores (_) or periods (.) and must begin with a lowercase letter. value: minLength: 1 type: string required: - key - value type: object LeftSidebarConfiguration: example: disabledMenus: - disabledMenus - disabledMenus properties: disabledMenus: items: type: string type: array type: object Level: enum: - ERROR - WARN - INFO - DEBUG - TRACE type: string LogEntry: properties: namespace: type: string flowId: type: string taskId: nullable: true type: string executionId: nullable: true type: string taskRunId: nullable: true type: string attemptNumber: format: int32 nullable: true type: integer triggerId: nullable: true type: string timestamp: format: date-time type: string level: $ref: "#/components/schemas/Level" thread: type: string message: type: string executionKind: allOf: - $ref: "#/components/schemas/ExecutionKind" nullable: true required: - flowId - namespace type: object Map_Object.Object_: example: empty: true properties: empty: type: boolean type: object MeController.ApiMe: properties: id: type: string superAdmin: type: boolean restricted: type: boolean profile: $ref: "#/components/schemas/MeController.ApiProfile" auths: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiAuthentication" type: array tenants: items: $ref: "#/components/schemas/MeController.ApiTenant" type: array type: object MeController.ApiProfile: properties: email: type: string firstName: type: string lastName: type: string username: type: string type: object MeController.ApiTenant: properties: id: type: string name: type: string logo: type: string type: object MeController.ApiUpdatePasswordRequest: properties: oldPassword: type: string newPassword: type: string type: object MeController.ApiUserDetailsRequest: properties: firstName: type: string lastName: type: string email: type: string type: object Meta: properties: resourceType: minLength: 1 type: string created: format: date-time type: string lastModified: format: date-time type: string location: type: string version: type: string type: object Metric: properties: name: type: string type: type: string description: type: string baseUnit: type: string tags: items: $ref: "#/components/schemas/Metric.Tag" type: array value: type: object type: object Metric.Tag: properties: key: type: string value: type: string type: object MetricAggregation: properties: name: type: string value: format: double type: number date: format: date-time type: string required: - date - name type: object MetricAggregations: properties: groupBy: type: string aggregations: items: $ref: "#/components/schemas/MetricAggregation" type: array required: - aggregations - groupBy type: object MetricEntry: properties: namespace: type: string flowId: type: string taskId: nullable: true type: string executionId: nullable: true type: string taskRunId: nullable: true type: string type: type: string name: type: string value: format: double type: number timestamp: format: date-time type: string tags: additionalProperties: type: string nullable: true type: object executionKind: allOf: - $ref: "#/components/schemas/ExecutionKind" nullable: true required: - flowId - name - namespace - timestamp - type - value type: object MiscController.Configuration: properties: uuid: type: string version: type: string edition: $ref: "#/components/schemas/EditionProvider.Edition" commitId: type: string chartDefaultDuration: type: string commitDate: format: date-time type: string isCustomDashboardsEnabled: type: boolean isAnonymousUsageEnabled: type: boolean isUiAnonymousUsageEnabled: type: boolean isTemplateEnabled: type: boolean environment: $ref: "#/components/schemas/MiscController.Environment" url: type: string preview: $ref: "#/components/schemas/MiscController.Preview" systemNamespace: type: string hiddenLabelsPrefixes: items: type: string type: array isAiEnabled: type: boolean isBasicAuthInitialized: type: boolean pluginsHash: format: int64 type: integer isConcurrencyViewEnabled: type: boolean type: object MiscController.EEConfiguration: allOf: - $ref: "#/components/schemas/MiscController.Configuration" - properties: tenants: $ref: "#/components/schemas/MiscController.TenantConfigurationInfo" secretsEnabled: type: boolean supportedStorages: items: $ref: "#/components/schemas/MiscController.PluginIdAndVersion" type: array supportedSecrets: items: $ref: "#/components/schemas/MiscController.PluginIdAndVersion" type: array pluginManagementEnabled: type: boolean pluginCustomEnabled: type: boolean banner: $ref: "#/components/schemas/Banner" mailServiceEnabled: type: boolean outputsInInternalStorageEnabled: type: boolean leftSidebar: $ref: "#/components/schemas/LeftSidebarConfiguration" rightSidebar: $ref: "#/components/schemas/RightSidebarConfiguration" inMaintenance: type: boolean passwordRegexp: type: string passwordlessEnabled: type: boolean airgapped: type: boolean featureGating: type: boolean features: items: type: string type: array killSwitches: items: $ref: "#/components/schemas/KillSwitch" type: array type: object example: preview: initial: 0 max: 6 isBasicAuthInitialized: true passwordlessEnabled: true inMaintenance: true edition: OSS pluginManagementEnabled: true isConcurrencyViewEnabled: true uuid: uuid pluginsHash: 1 killSwitches: - evaluationType: PASS executionIds: - executionIds - executionIds deleted: true endDate: 2000-01-23T04:56:07.000+00:00 name: name tenantId: tenantId namespace: namespace description: description id: id flowId: flowId startDate: 2000-01-23T04:56:07.000+00:00 enabled: true - evaluationType: PASS executionIds: - executionIds - executionIds deleted: true endDate: 2000-01-23T04:56:07.000+00:00 name: name tenantId: tenantId namespace: namespace description: description id: id flowId: flowId startDate: 2000-01-23T04:56:07.000+00:00 enabled: true isCustomDashboardsEnabled: true featureGating: true leftSidebar: disabledMenus: - disabledMenus - disabledMenus features: - features - features outputsInInternalStorageEnabled: true supportedStorages: - id: id version: version - id: id version: version isUiAnonymousUsageEnabled: true mailServiceEnabled: true pluginCustomEnabled: true airgapped: true supportedSecrets: - id: id version: version - id: id version: version isAiEnabled: true tenants: secretByTenant: true storageByTenant: true hiddenLabelsPrefixes: - hiddenLabelsPrefixes - hiddenLabelsPrefixes banner: endDate: 2000-01-23T04:56:07.000+00:00 tenantId: tenantId active: true id: id message: message type: INFO startDate: 2000-01-23T04:56:07.000+00:00 commitId: commitId isAnonymousUsageEnabled: true version: version rightSidebar: customLinks: key: title: title url: url passwordRegexp: passwordRegexp url: url commitDate: 2000-01-23T04:56:07.000+00:00 environment: color: color name: name chartDefaultDuration: chartDefaultDuration secretsEnabled: true isTemplateEnabled: true systemNamespace: systemNamespace type: object MiscController.Environment: example: color: color name: name properties: name: type: string color: type: string type: object MiscController.LicenseInfo: example: maxServers: 0 gracePeriod: 2000-01-23T04:56:07.000+00:00 expired: true standalone: true online: true expiry: 2000-01-23T04:56:07.000+00:00 type: type workerGroups: true properties: type: type: string expiry: format: date-time type: string expired: type: boolean maxServers: format: int32 type: integer standalone: type: boolean workerGroups: type: boolean online: type: boolean gracePeriod: format: date-time type: string type: object MiscController.PluginIdAndVersion: example: id: id version: version properties: id: type: string version: type: string type: object MiscController.Preview: example: initial: 0 max: 6 properties: initial: format: int32 type: integer max: format: int32 type: integer type: object MiscController.TenantConfigurationInfo: example: secretByTenant: true storageByTenant: true properties: storageByTenant: type: boolean secretByTenant: type: boolean type: object Name: description: Scim core schema. properties: familyName: type: string givenName: type: string type: object Namespace: allOf: - $ref: "#/components/schemas/NamespaceLight" - description: A namespace is a logical grouping of flows and tasks. It is used to organize and manage flows and tasks within Kestra. properties: id: pattern: "^[a-z0-9][a-z0-9._-]*" type: string storageIsolation: $ref: "#/components/schemas/Isolation" secretIsolation: $ref: "#/components/schemas/Isolation" deleted: type: boolean description: type: string variables: additionalProperties: type: object type: object pluginDefaults: items: $ref: "#/components/schemas/PluginDefault" type: array allowedNamespaces: items: $ref: "#/components/schemas/Namespace.AllowedNamespace" type: array workerGroup: $ref: "#/components/schemas/WorkerGroup" storageType: type: string storageConfiguration: additionalProperties: type: object type: object secretType: type: string secretReadOnly: type: boolean secretConfiguration: additionalProperties: type: object type: object outputsInInternalStorage: type: boolean sdkDefaultAuthentication: $ref: "#/components/schemas/SDK.Auth" required: - deleted - id type: object example: null example: variables: key: "{}" secretConfiguration: key: "{}" storageIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true description: description pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type secretReadOnly: true secretIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true allowedNamespaces: - namespace: namespace - namespace: namespace deleted: true storageConfiguration: key: "{}" secretType: secretType storageType: storageType id: id workerGroup: fallback: FAIL key: key outputsInInternalStorage: true sdkDefaultAuthentication: password: password apiToken: apiToken username: username type: object Namespace.AllowedNamespace: example: namespace: namespace properties: namespace: type: string required: - namespace type: object NamespaceController.ApiInheritedPluginDefaultFromNamespace: example: forced: true values: "{}" namespace: namespace type: type properties: type: type: string forced: type: boolean values: additionalProperties: false type: object namespace: type: string required: - type type: object NamespaceFileRevision: example: revision: 0 properties: revision: format: int32 type: integer type: object NamespaceLight: properties: id: pattern: "^[a-z0-9][a-z0-9._-]*" type: string required: - id type: object Output: example: displayName: displayName description: description id: id type: STRING value: "{}" required: true properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][.a-zA-Z0-9_-]*" type: string description: type: string value: $ref: "#/components/schemas/Output_value" type: $ref: "#/components/schemas/Type" displayName: type: string required: type: boolean required: - id - type - value type: object PageRequest: properties: startIndex: format: int32 type: integer count: format: int32 type: integer type: object PagedResults_ApiGroupSummary_: example: total: 0 results: - name: name id: id - name: name id: id properties: results: items: $ref: "#/components/schemas/ApiGroupSummary" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_ApiRoleSummary_: example: total: 0 results: - isDefault: true name: name id: id isManaged: true - isDefault: true name: name id: id isManaged: true properties: results: items: $ref: "#/components/schemas/ApiRoleSummary" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AppsController.ApiAppCatalogItem_: properties: results: items: $ref: "#/components/schemas/AppsController.ApiAppCatalogItem" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AppsController.ApiApp_: properties: results: items: $ref: "#/components/schemas/AppsController.ApiApp" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AssetsController.ApiAssetLineageEvent_: properties: results: items: $ref: "#/components/schemas/AssetsController.ApiAssetLineageEvent" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AssetsController.ApiAssetUsage_: properties: results: items: $ref: "#/components/schemas/AssetsController.ApiAssetUsage" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AssetsController.ApiAsset_: properties: results: items: $ref: "#/components/schemas/AssetsController.ApiAsset" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_AuditLogController.ApiAuditLogItem_: properties: results: items: $ref: "#/components/schemas/AuditLogController.ApiAuditLogItem" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_BlueprintController.ApiBlueprintItem_: properties: results: items: $ref: "#/components/schemas/BlueprintController.ApiBlueprintItem" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Blueprint_: properties: results: items: $ref: "#/components/schemas/Blueprint" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_ConcurrencyLimit_: example: total: 6 results: - running: 0 tenantId: tenantId namespace: namespace flowId: flowId - running: 0 tenantId: tenantId namespace: namespace flowId: flowId properties: results: items: $ref: "#/components/schemas/ConcurrencyLimit" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Dashboard_: properties: results: items: $ref: "#/components/schemas/Dashboard" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Execution_: example: total: 5 results: - outputs: "{}" variables: "{}" metadata: attemptNumber: 1 originalCreatedDate: 2000-01-23T04:56:07.000+00:00 inputs: "{}" kind: "" trigger: variables: key: "" logFile: https://openapi-generator.tech id: id type: type taskRunList: - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 parentId: parentId labels: - value: value key: key - value: value key: key fixtures: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value traceParent: traceParent flowRevision: 0 deleted: true namespace: namespace scheduleDate: 2000-01-23T04:56:07.000+00:00 id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 originalId: originalId breakpoints: - id: id value: value - id: id value: value flowId: flowId - outputs: "{}" variables: "{}" metadata: attemptNumber: 1 originalCreatedDate: 2000-01-23T04:56:07.000+00:00 inputs: "{}" kind: "" trigger: variables: key: "" logFile: https://openapi-generator.tech id: id type: type taskRunList: - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 parentId: parentId labels: - value: value key: key - value: value key: key fixtures: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value traceParent: traceParent flowRevision: 0 deleted: true namespace: namespace scheduleDate: 2000-01-23T04:56:07.000+00:00 id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 originalId: originalId breakpoints: - id: id value: value - id: id value: value flowId: flowId properties: results: items: $ref: "#/components/schemas/Execution" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Flow_: example: total: 1 results: - outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null - outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null properties: results: items: $ref: "#/components/schemas/Flow" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMBindingController.ApiBindingDetail_: properties: results: items: $ref: "#/components/schemas/IAMBindingController.ApiBindingDetail" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMGroupController.ApiGroupMember_: example: total: 0 results: - displayName: displayName groups: - external: true name: name id: id membership: OWNER - external: true name: name id: id membership: OWNER id: id username: username - displayName: displayName groups: - external: true name: name id: id membership: OWNER - external: true name: name id: id membership: OWNER id: id username: username properties: results: items: $ref: "#/components/schemas/IAMGroupController.ApiGroupMember" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMInvitationController.ApiInvitationDetail_: properties: results: items: $ref: "#/components/schemas/IAMInvitationController.ApiInvitationDetail" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMServiceAccountController.ApiServiceAccountDetail_: example: total: 0 results: - tenants: - name: name id: id - name: name id: id name: name description: description id: id superAdmin: true - tenants: - name: name id: id - name: name id: id name: name description: description id: id superAdmin: true properties: results: items: $ref: "#/components/schemas/IAMServiceAccountController.ApiServiceAccountDetail" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMTenantAccessController.ApiUserTenantAccess_: properties: results: items: $ref: "#/components/schemas/IAMTenantAccessController.ApiUserTenantAccess" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_IAMUserController.ApiUserSummary_: example: total: 0 results: - tenants: - name: name id: id - name: name id: id displayName: displayName auths: - name: name id: id type: type - name: name id: id type: type id: id superAdmin: true username: username - tenants: - name: name id: id - name: name id: id displayName: displayName auths: - name: name id: id type: type - name: name id: id type: type id: id superAdmin: true username: username properties: results: items: $ref: "#/components/schemas/IAMUserController.ApiUserSummary" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_InstanceController.ApiPluginArtifact_: properties: results: items: $ref: "#/components/schemas/InstanceController.ApiPluginArtifact" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_InstanceController.ApiServiceInstance_: properties: results: items: $ref: "#/components/schemas/InstanceController.ApiServiceInstance" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_KVEntry_: example: total: 6 results: - updateDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace description: description creationDate: 2000-01-23T04:56:07.000+00:00 version: 0 key: key expirationDate: 2000-01-23T04:56:07.000+00:00 - updateDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace description: description creationDate: 2000-01-23T04:56:07.000+00:00 version: 0 key: key expirationDate: 2000-01-23T04:56:07.000+00:00 properties: results: items: $ref: "#/components/schemas/KVEntry" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_LogEntry_: properties: results: items: $ref: "#/components/schemas/LogEntry" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Map_String.Object__: properties: results: items: additionalProperties: type: object type: object type: array total: format: int64 type: integer required: - results - total type: object PagedResults_MetricEntry_: properties: results: items: $ref: "#/components/schemas/MetricEntry" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Namespace_: example: total: 0 results: - variables: key: "{}" secretConfiguration: key: "{}" storageIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true description: description pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type secretReadOnly: true secretIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true allowedNamespaces: - namespace: namespace - namespace: namespace deleted: true storageConfiguration: key: "{}" secretType: secretType storageType: storageType id: id workerGroup: fallback: FAIL key: key outputsInInternalStorage: true sdkDefaultAuthentication: password: password apiToken: apiToken username: username - variables: key: "{}" secretConfiguration: key: "{}" storageIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true description: description pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type secretReadOnly: true secretIsolation: deniedServices: - EXECUTOR - EXECUTOR enabled: true allowedNamespaces: - namespace: namespace - namespace: namespace deleted: true storageConfiguration: key: "{}" secretType: secretType storageType: storageType id: id workerGroup: fallback: FAIL key: key outputsInInternalStorage: true sdkDefaultAuthentication: password: password apiToken: apiToken username: username properties: results: items: $ref: "#/components/schemas/Namespace" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_SearchResult_Flow__: example: total: 0 results: - model: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null fragments: - fragments - fragments - model: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null fragments: - fragments - fragments properties: results: items: $ref: "#/components/schemas/SearchResult_Flow_" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Tenant_: properties: results: items: $ref: "#/components/schemas/Tenant" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_TestSuiteRunResult_: example: total: 0 results: - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 properties: results: items: $ref: "#/components/schemas/TestSuiteRunResult" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_TestSuite_: example: total: 0 results: - deleted: true testCases: - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value namespace: namespace description: description disabled: true id: id source: source flowId: flowId - deleted: true testCases: - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value namespace: namespace description: description disabled: true id: id source: source flowId: flowId properties: results: items: $ref: "#/components/schemas/TestSuite" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_TriggerController.Triggers_: example: total: 0 results: - triggerContext: date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId abstractTrigger: allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - triggerContext: date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId abstractTrigger: allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type properties: results: items: $ref: "#/components/schemas/TriggerController.Triggers" type: array total: format: int64 type: integer required: - results - total type: object PagedResults_Trigger_: example: total: 0 results: - date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId - date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId properties: results: items: $ref: "#/components/schemas/Trigger" type: array total: format: int64 type: integer required: - results - total type: object PatchOperation: properties: operation: $ref: "#/components/schemas/PatchOperation.Type" path: $ref: "#/components/schemas/PatchOperationPath" value: type: object type: object PatchOperation.Type: enum: - ADD - REMOVE - REPLACE type: string PatchOperationPath: properties: valuePathExpression: $ref: "#/components/schemas/ValuePathExpression" type: object PatchRequest: allOf: - $ref: "#/components/schemas/BaseResource_PatchRequest_" - properties: patchOperationList: items: $ref: "#/components/schemas/PatchOperation" type: array type: object type: object Permission: enum: - FLOW - BLUEPRINT - TEMPLATE - NAMESPACE - EXECUTION - USER - GROUP - ROLE - BINDING - AUDITLOG - SECRET - KVSTORE - IMPERSONATE - SETTING - APP - ASSET - APPEXECUTION - TEST - DASHBOARD - TENANT_ACCESS - SERVICE_ACCOUNT - INVITATION - GROUP_MEMBERSHIP - CREDENTIAL - AI_COPILOT - UNKNOWN type: string Plugin: properties: name: type: string title: type: string description: type: string license: type: string longDescription: type: string group: type: string version: type: string manifest: additionalProperties: type: string type: object guides: items: type: string type: array aliases: items: type: string type: array tasks: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array triggers: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array conditions: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array controllers: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array storages: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array secrets: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array taskRunners: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array apps: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array appBlocks: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array charts: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array dataFilters: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array dataFiltersKPI: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array logExporters: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array additionalPlugins: items: $ref: "#/components/schemas/Plugin.PluginElementMetadata" type: array categories: items: $ref: "#/components/schemas/PluginSubGroup.PluginCategory" type: array subGroup: type: string type: object Plugin.PluginElementMetadata: properties: cls: type: string deprecated: type: boolean title: type: string description: type: string type: object PluginArtifact: properties: groupId: type: string artifactId: type: string extension: type: string classifier: type: string version: type: string uri: format: uri type: string type: object PluginArtifactMetadata: properties: uri: format: uri type: string name: type: string size: format: int64 type: integer lastModifiedTime: format: int64 type: integer creationTime: format: int64 type: integer type: object PluginController.ApiPluginVersions: properties: type: type: string versions: items: type: string type: array type: object PluginDefault: example: forced: true values: "{}" type: type properties: type: type: string forced: type: boolean values: additionalProperties: false type: object required: - type type: object PluginIcon: properties: name: type: string icon: type: string flowable: type: boolean type: object PluginSchema: properties: properties: additionalProperties: type: object type: object outputs: additionalProperties: type: object type: object definitions: additionalProperties: type: object type: object type: object PluginSubGroup.PluginCategory: enum: - DATABASE - MESSAGING - SCRIPT - TRANSFORMATION - BATCH - ALERTING - CLOUD - STORAGE - OTHER - TOOL - AI - CORE - INGESTION - BI - BUSINESS - DATA - INFRASTRUCTURE type: string Property_Boolean_: example: expression: expression value: true oneOf: - type: object - type: string properties: expression: type: string value: type: boolean type: object Property_Double_: example: expression: expression value: 0.8008281904610115 oneOf: - type: object - type: string properties: expression: type: string value: format: double type: number type: object Property_Duration_: example: expression: expression value: value oneOf: - type: object - type: string properties: expression: type: string value: type: string type: object Property_List_AssetIdentifier__: example: expression: expression value: - id: id type: type - id: id type: type oneOf: - type: object - type: string properties: expression: type: string value: items: $ref: "#/components/schemas/AssetIdentifier" type: array type: object Property_List_Asset__: example: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type oneOf: - type: object - type: string properties: expression: type: string value: items: $ref: "#/components/schemas/Asset" type: array type: object Property_List_String__: example: expression: expression value: - value - value oneOf: - type: object - type: string properties: expression: type: string value: items: type: string type: array type: object Property_Object_: example: expression: expression value: "{}" oneOf: - type: object - type: string properties: expression: type: string value: type: object type: object Property_String_: example: expression: expression value: value oneOf: - type: object - type: string properties: expression: type: string value: type: string type: object QueryFilter: properties: field: $ref: "#/components/schemas/QueryFilter.Field" operation: $ref: "#/components/schemas/QueryFilter.Op" value: type: object type: object QueryFilter.Field: enum: - QUERY - SCOPE - NAMESPACE - KIND - LABELS - METADATA - FLOW_ID - FLOW_REVISION - ID - ASSET_ID - TYPE - CREATED - UPDATED - START_DATE - END_DATE - EXPIRATION_DATE - STATE - TIME_RANGE - TRIGGER_EXECUTION_ID - TRIGGER_ID - TRIGGER_STATE - EXECUTION_ID - TASK_ID - TASK_RUN_ID - CHILD_FILTER - WORKER_ID - EXISTING_ONLY - MIN_LEVEL - PATH - PARENT_PATH - VERSION - USERNAME type: string x-type: String QueryFilter.Op: enum: - EQUALS - NOT_EQUALS - GREATER_THAN - LESS_THAN - GREATER_THAN_OR_EQUAL_TO - LESS_THAN_OR_EQUAL_TO - IN - NOT_IN - STARTS_WITH - ENDS_WITH - CONTAINS - REGEX - PREFIX type: string RBACService.RoleAssignment.RoleOrigin: enum: - BINDING - GROUP type: string Relation: example: relationType: SEQUENTIAL value: value properties: relationType: $ref: "#/components/schemas/RelationType" value: type: string type: object RelationType: enum: - SEQUENTIAL - CHOICE - ERROR - FINALLY - AFTER_EXECUTION - PARALLEL - DYNAMIC type: string Relation_1: enum: - UPSERT - USED_BY type: string ResourceType: enum: - AUDITLOG - APP - ASSET - APP_EXECUTION - BLUEPRINT - BINDING - DASHBOARD - EXECUTION - FLOW - KILL_SWITCH - KV_STORE - GROUP - INVITATION - NAMESPACE - NAMESPACE_FILE - ROLE - SECURITY_INTEGRATION - SECRET - SETTING - TEMPLATE - TRIGGER - TENANT - TENANT_ACCESS - TESTSUITE - TESTSUITE_RUN - VERSIONED_PLUGIN - USER - CREDENTIAL - WORKER_GROUP - INSTANCE - UNKNOWN type: string ResourceType.SchemaExtensionConfiguration: properties: schemaUrn: minLength: 1 type: string required: type: boolean type: object ResourceType_1: allOf: - $ref: "#/components/schemas/ScimResourceWithOptionalId" - $ref: "#/components/schemas/ScimResource" - $ref: "#/components/schemas/BaseResource_ScimResource_" - properties: id: type: string name: minLength: 1 type: string description: type: string endpoint: minLength: 1 type: string schemaUrn: minLength: 1 type: string schemaExtensions: items: $ref: "#/components/schemas/ResourceType.SchemaExtensionConfiguration" type: array type: object type: object RightSidebarConfiguration: example: customLinks: key: title: title url: url properties: customLinks: additionalProperties: $ref: "#/components/schemas/RightSidebarConfiguration.CustomLink" type: object type: object RightSidebarConfiguration.CustomLink: example: title: title url: url properties: title: type: string url: type: string type: object Role: example: isDefault: true deleted: true permissions: NAMESPACE: - NAMESPACE - NAMESPACE APPEXECUTION: - APPEXECUTION - APPEXECUTION APP: - APP - APP TENANT_ACCESS: - TENANT_ACCESS - TENANT_ACCESS SERVICE_ACCOUNT: - SERVICE_ACCOUNT - SERVICE_ACCOUNT AI_COPILOT: - AI_COPILOT - AI_COPILOT BLUEPRINT: - BLUEPRINT - BLUEPRINT FLOW: - FLOW - FLOW ROLE: - ROLE - ROLE GROUP: - GROUP - GROUP DASHBOARD: - DASHBOARD - DASHBOARD IMPERSONATE: - IMPERSONATE - IMPERSONATE TEMPLATE: - TEMPLATE - TEMPLATE AUDITLOG: - AUDITLOG - AUDITLOG SETTING: - SETTING - SETTING KVSTORE: - KVSTORE - KVSTORE EXECUTION: - EXECUTION - EXECUTION ASSET: - ASSET - ASSET USER: - USER - USER GROUP_MEMBERSHIP: - GROUP_MEMBERSHIP - GROUP_MEMBERSHIP INVITATION: - INVITATION - INVITATION TEST: - TEST - TEST CREDENTIAL: - CREDENTIAL - CREDENTIAL UNKNOWN: - UNKNOWN - UNKNOWN BINDING: - BINDING - BINDING SECRET: - SECRET - SECRET name: name description: description id: id isManaged: true properties: isManaged: type: boolean permissions: $ref: "#/components/schemas/IAMRoleController_ApiRoleCreateOrUpdateRequest_permissions" id: type: string name: type: string description: type: string isDefault: type: boolean deleted: type: boolean required: - deleted - isManaged - name type: object SDK.Auth: example: password: password apiToken: apiToken username: username properties: apiToken: nullable: true type: string username: nullable: true type: string password: nullable: true type: string type: object SLA: example: id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels properties: id: minLength: 1 type: string type: $ref: "#/components/schemas/SLA.Type" behavior: $ref: "#/components/schemas/SLA.Behavior" labels: $ref: "#/components/schemas/SLA_labels" required: - behavior - id - type type: object SLA.Behavior: enum: - FAIL - CANCEL - NONE type: string SLA.Type: enum: - MAX_DURATION - EXECUTION_ASSERTION type: string Schema: properties: attributes: items: $ref: "#/components/schemas/Schema.Attribute" maxItems: 65535 minItems: 1 type: array id: maxLength: 65535 minLength: 1 type: string name: type: string description: type: string meta: $ref: "#/components/schemas/Meta" required: - id type: object Schema.Attribute: properties: attributes: items: $ref: "#/components/schemas/Schema.Attribute" type: array urn: type: string name: pattern: "\\p{Alpha}(-|_|\\p{Alnum})*" type: string type: $ref: "#/components/schemas/Schema.Attribute.Type" subAttributes: items: $ref: "#/components/schemas/Schema.Attribute" type: array multiValued: type: boolean description: type: string required: type: boolean canonicalValues: items: type: string type: array caseExact: type: boolean mutability: $ref: "#/components/schemas/Schema.Attribute.Mutability" returned: $ref: "#/components/schemas/Schema.Attribute.Returned" uniqueness: $ref: "#/components/schemas/Schema.Attribute.Uniqueness" referenceTypes: items: type: string type: array accessor: type: object scimResourceIdReference: type: boolean type: object Schema.Attribute.Mutability: enum: - IMMUTABLE - READ_ONLY - READ_WRITE - WRITE_ONLY type: string Schema.Attribute.Returned: enum: - ALWAYS - DEFAULT - NEVER - REQUEST type: string Schema.Attribute.Type: enum: - BINARY - BOOLEAN - COMPLEX - DATE_TIME - DECIMAL - INTEGER - REFERENCE - STRING type: string Schema.Attribute.Uniqueness: enum: - GLOBAL - NONE - SERVER type: string Schema.AttributeAccessor: type: object SchemaType: enum: - FLOW - TEMPLATE - TASK - TRIGGER - PLUGINDEFAULT - APPS - TESTSUITES - DASHBOARD type: string ScimExtension: properties: urn: type: string type: object ScimResource: allOf: - $ref: "#/components/schemas/BaseResource_ScimResource_" - properties: baseUrn: type: string extensions: additionalProperties: $ref: "#/components/schemas/ScimExtension" type: object meta: $ref: "#/components/schemas/Meta" id: minLength: 1 type: string externalId: type: string resourceType: type: string type: object required: - meta type: object ScimResourceWithOptionalId: allOf: - $ref: "#/components/schemas/ScimResource" - $ref: "#/components/schemas/BaseResource_ScimResource_" - properties: id: type: string type: object type: object ScimUser: allOf: - $ref: "#/components/schemas/ScimResource" - $ref: "#/components/schemas/BaseResource_ScimResource_" - properties: primaryEmailAddress: allOf: - $ref: "#/components/schemas/Email" nullable: true active: type: boolean emails: items: $ref: "#/components/schemas/Email" type: array userName: type: string name: $ref: "#/components/schemas/Name" groups: items: $ref: "#/components/schemas/UserGroup" type: array type: object description: Scim core schema. type: object SearchRequest: allOf: - $ref: "#/components/schemas/BaseResource_SearchRequest_" - properties: pageRequest: $ref: "#/components/schemas/PageRequest" sortRequest: $ref: "#/components/schemas/SortRequest" attributes: items: $ref: "#/components/schemas/AttributeReference" type: array excludedAttributes: items: $ref: "#/components/schemas/AttributeReference" type: array filter: $ref: "#/components/schemas/Filter" sortBy: $ref: "#/components/schemas/AttributeReference" sortOrder: $ref: "#/components/schemas/SortOrder" startIndex: format: int32 type: integer count: format: int32 type: integer type: object type: object SearchResult_Flow_: example: model: outputs: - displayName: displayName description: description id: id type: STRING value: "{}" required: true - displayName: displayName description: description id: id type: STRING value: "{}" required: true variables: null inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true finally: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" description: description sla: - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels - id: id type: MAX_DURATION behavior: FAIL labels: - SLA_labels - SLA_labels afterExecution: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" triggers: - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type - allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type pluginDefaults: - forced: true values: "{}" type: type - forced: true values: "{}" type: type revision: 1 labels: - value: value key: key - value: value key: key concurrency: limit: 1 behavior: QUEUE deleted: true checks: - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION - condition: condition style: ERROR message: message behavior: BLOCK_EXECUTION namespace: namespace disabled: true id: id workerGroup: fallback: FAIL key: key updated: 2000-01-23T04:56:07.000+00:00 tasks: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" errors: - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" - taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" retry: null fragments: - fragments - fragments properties: model: $ref: "#/components/schemas/Flow" fragments: items: type: string type: array type: object SecurityIntegration.Type: enum: - SCIM type: string ServerConfig: properties: workerTaskRestartStrategy: allOf: - $ref: "#/components/schemas/WorkerTaskRestartStrategy" nullable: true terminationGracePeriod: default: 5m type: string liveness: $ref: "#/components/schemas/ServerConfig.Liveness" required: - terminationGracePeriod type: object ServerConfig.Liveness: properties: enabled: default: true type: boolean interval: default: 5s type: string timeout: default: 45s type: string initialDelay: default: 45s type: string heartbeatInterval: default: 3s type: string required: - enabled - heartbeatInterval - initialDelay - interval - timeout type: object ServerInstance: properties: id: type: string type: $ref: "#/components/schemas/ServerInstance.Type" version: type: string hostname: type: string props: additionalProperties: type: object type: object metrics: items: $ref: "#/components/schemas/Metric" type: array required: - hostname - id - metrics - props - type - version type: object ServerInstance.Type: enum: - SERVER - STANDALONE type: string Service.ServiceState: enum: - CREATED - RUNNING - ERROR - DISCONNECTED - TERMINATING - TERMINATED_GRACEFULLY - TERMINATED_FORCED - NOT_RUNNING - INACTIVE - MAINTENANCE type: string ServiceInstance: properties: server: $ref: "#/components/schemas/ServerInstance" metrics: items: $ref: "#/components/schemas/Metric" type: array state: $ref: "#/components/schemas/Service.ServiceState" id: type: string type: $ref: "#/components/schemas/ServiceType" createdAt: format: date-time type: string updatedAt: format: date-time type: string events: items: $ref: "#/components/schemas/ServiceInstance.TimestampedEvent" type: array config: $ref: "#/components/schemas/ServerConfig" props: additionalProperties: type: object type: object seqId: format: int64 type: integer type: object ServiceInstance.TimestampedEvent: properties: ts: format: date-time type: string value: type: string type: type: string state: $ref: "#/components/schemas/Service.ServiceState" type: object ServiceProviderConfiguration: allOf: - $ref: "#/components/schemas/ScimResourceWithOptionalId" - $ref: "#/components/schemas/ScimResource" - $ref: "#/components/schemas/BaseResource_ScimResource_" - properties: id: type: string documentationUrl: type: string patch: $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" bulk: $ref: "#/components/schemas/ServiceProviderConfiguration.BulkConfiguration" filter: $ref: "#/components/schemas/ServiceProviderConfiguration.FilterConfiguration" changePassword: $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" sort: $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" etag: $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" authenticationSchemes: items: $ref: "#/components/schemas/ServiceProviderConfiguration.AuthenticationSchema" type: array type: object type: object ServiceProviderConfiguration.AuthenticationSchema: properties: type: $ref: "#/components/schemas/ServiceProviderConfiguration.AuthenticationSchema.Type" name: type: string description: type: string specUri: type: string documentationUri: type: string type: object ServiceProviderConfiguration.AuthenticationSchema.Type: enum: - OAUTH - OAUTH2 - OAUTH_BEARER - HTTP_BASIC - HTTP_DIGEST type: string ServiceProviderConfiguration.BulkConfiguration: allOf: - $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" - properties: maxOperations: format: int32 type: integer maxPayloadSize: format: int32 type: integer type: object type: object ServiceProviderConfiguration.FilterConfiguration: allOf: - $ref: "#/components/schemas/ServiceProviderConfiguration.SupportedConfiguration" - properties: maxResults: format: int32 type: integer type: object type: object ServiceProviderConfiguration.SupportedConfiguration: properties: supported: type: boolean type: object ServiceType: enum: - EXECUTOR - INDEXER - SCHEDULER - WEBSERVER - WORKER - INVALID type: string SetupConfiguration: example: haveAuthNotBasic: true secretType: secretType repositoryType: repositoryType queueType: queueType storageType: storageType done: true passwordRegexp: passwordRegexp properties: done: type: boolean repositoryType: type: string queueType: type: string storageType: type: string secretType: type: string passwordRegexp: type: string haveAuthNotBasic: type: boolean type: object SoftDeletable_FlowInterface_: properties: deleted: type: boolean type: object SortOrder: enum: - ASCENDING - DESCENDING type: string SortRequest: properties: sortBy: $ref: "#/components/schemas/AttributeReference" sortOrder: $ref: "#/components/schemas/SortOrder" type: object State: example: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 properties: duration: nullable: true readOnly: true type: string startDate: format: date-time readOnly: true type: string endDate: format: date-time nullable: true readOnly: true type: string current: $ref: "#/components/schemas/State.Type" histories: items: $ref: "#/components/schemas/State.History" type: array required: - current type: object State.History: example: date: 2000-01-23T04:56:07.000+00:00 state: null properties: state: $ref: "#/components/schemas/State.Type" date: format: date-time type: string required: - date - state type: object State.Type: enum: - CREATED - SUBMITTED - RUNNING - PAUSED - RESTARTED - KILLING - SUCCESS - WARNING - FAILED - KILLED - CANCELLED - QUEUED - RETRYING - RETRIED - SKIPPED - BREAKPOINT - RESUBMITTED type: string Task: example: taskCache: ttl: ttl enabled: true description: description type: type logToFile: true version: version timeout: expression: expression value: value allowWarning: true allowFailure: true assets: "" logLevel: ERROR runIf: runIf disabled: true id: id workerGroup: fallback: FAIL key: key retry: "{}" properties: id: maxLength: 256 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" type: string x-size-message: Task id must be at most 256 characters type: minLength: 1 pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" title: The class name of this task. type: string version: description: | Defines the version of the plugin to use. The version must follow the Semantic Versioning (SemVer) specification: - A single-digit MAJOR version (e.g., `1`). - A MAJOR.MINOR version (e.g., `1.1`). - A MAJOR.MINOR.PATCH version, optionally with any qualifier (e.g., `1.1.2`, `1.1.0-SNAPSHOT`). title: Plugin Version type: string description: type: string retry: type: object timeout: $ref: "#/components/schemas/Property_Duration_" disabled: type: boolean workerGroup: $ref: "#/components/schemas/WorkerGroup" logLevel: $ref: "#/components/schemas/Level" allowFailure: type: boolean logToFile: type: boolean runIf: type: string allowWarning: type: boolean taskCache: $ref: "#/components/schemas/Cache" assets: allOf: - $ref: "#/components/schemas/AssetsDeclaration" nullable: true required: - id - type type: object TaskFixture: example: outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value properties: id: type: string value: type: string state: $ref: "#/components/schemas/State.Type" outputs: additionalProperties: type: object type: object assets: items: $ref: "#/components/schemas/Asset" type: array description: $ref: "#/components/schemas/Property_String_" required: - id type: object TaskForExecution: example: inputs: - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true - dependsOn: "" defaults: "" displayName: displayName prefill: "" description: description id: id type: "" required: true subflowId: namespace: namespace flowId: flowId revision: 1 id: id type: type version: version tasks: - null - null properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" type: string type: minLength: 1 pattern: "^[A-Za-z_$][A-Za-z0-9_$]*(\\.[A-Za-z_$][A-Za-z0-9_$]*)*$" title: The class name of this task. type: string version: description: | Defines the version of the plugin to use. The version must follow the Semantic Versioning (SemVer) specification: - A single-digit MAJOR version (e.g., `1`). - A MAJOR.MINOR version (e.g., `1.1`). - A MAJOR.MINOR.PATCH version, optionally with any qualifier (e.g., `1.1.2`, `1.1.0-SNAPSHOT`). title: Plugin Version type: string tasks: items: $ref: "#/components/schemas/TaskForExecution" type: array inputs: items: $ref: "#/components/schemas/Input_Object_" type: array subflowId: $ref: "#/components/schemas/ExecutableTask.SubflowId" required: - id - type type: object TaskRun: example: outputs: "{}" parentTaskRunId: parentTaskRunId executionId: executionId forceExecution: true assets: "" namespace: namespace iteration: 6 dynamic: true id: id state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId value: value taskId: taskId attempts: - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 - workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 properties: id: type: string executionId: type: string namespace: type: string flowId: type: string taskId: type: string parentTaskRunId: type: string value: type: string attempts: items: $ref: "#/components/schemas/TaskRunAttempt" type: array outputs: nullable: true type: object assets: allOf: - $ref: "#/components/schemas/AssetsInOut" nullable: true state: $ref: "#/components/schemas/State" iteration: format: int32 type: integer dynamic: type: boolean forceExecution: type: boolean required: - executionId - flowId - id - namespace - state - taskId type: object TaskRunAttempt: example: workerId: workerId logFile: https://openapi-generator.tech state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 properties: state: $ref: "#/components/schemas/State" workerId: nullable: true type: string logFile: format: uri nullable: true type: string required: - state type: object Tenant: properties: storageIsolation: $ref: "#/components/schemas/Isolation" secretIsolation: $ref: "#/components/schemas/Isolation" id: pattern: "^[a-z0-9][a-z0-9_-]*" type: string name: type: string deleted: type: boolean workerGroup: $ref: "#/components/schemas/WorkerGroup" storageType: type: string storageConfiguration: additionalProperties: type: object type: object secretType: type: string secretReadOnly: type: boolean secretConfiguration: additionalProperties: type: object type: object requireExistingNamespace: type: boolean outputsInInternalStorage: type: boolean appCatalogConfig: $ref: "#/components/schemas/Tenant.AppCatalogConfig" sdkDefaultAuthentication: $ref: "#/components/schemas/SDK.Auth" required: - deleted - id - name type: object Tenant.AppCatalogConfig: properties: title: type: string titleColor: type: string primaryColor: type: string type: object TenantController.AppsCatalogConfigRequest: properties: title: type: string titleColor: type: string primaryColor: type: string type: object TenantController.AppsCatalogConfigResponse: properties: title: type: string titleColor: type: string primaryColor: type: string logo: type: string type: object TenantInterface: properties: tenantId: type: string type: object TestState: enum: - ERROR - SUCCESS - FAILED - SKIPPED type: string TestSuite: example: deleted: true testCases: - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value namespace: namespace description: description disabled: true id: id source: source flowId: flowId properties: id: minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9_-]*" type: string description: type: string namespace: maxLength: 150 minLength: 1 pattern: "^[a-z0-9][a-z0-9._-]*" type: string flowId: maxLength: 100 minLength: 1 pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*" type: string source: type: string testCases: items: $ref: "#/components/schemas/UnitTest" minItems: 1 type: array deleted: type: boolean disabled: type: boolean required: - flowId - id - namespace - testCases type: object TestSuiteController.RunRequest: properties: testCases: items: type: string type: array type: object TestSuiteController.SearchTestsLastResult: properties: testSuiteIds: items: $ref: "#/components/schemas/TestSuiteController.TestSuiteApiId" type: array type: object TestSuiteController.TestSuiteApiId: properties: namespace: minLength: 1 type: string id: minLength: 1 type: string required: - id - namespace type: object TestSuiteController.TestSuiteBulkRequest: properties: ids: items: $ref: "#/components/schemas/TestSuiteController.TestSuiteApiId" minItems: 1 type: array required: - ids type: object TestSuiteController.TestsLastResultResponse: example: results: - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 properties: results: items: $ref: "#/components/schemas/TestSuiteRunResult" type: array type: object TestSuiteGenerationPrompt: properties: conversationId: type: string userPrompt: type: string yaml: type: string providerId: type: string required: - conversationId - userPrompt type: object TestSuiteRunResult: example: endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 properties: id: type: string testSuiteId: type: string namespace: type: string flowId: type: string state: $ref: "#/components/schemas/TestState" startDate: format: date-time type: string endDate: format: date-time type: string results: items: $ref: "#/components/schemas/UnitTestResult" type: array required: - endDate - flowId - id - namespace - startDate - state - testSuiteId type: object TestSuiteService.RunByQueryRequest: example: namespace: namespace flowId: flowId includeChildNamespaces: true properties: namespace: nullable: true type: string flowId: nullable: true type: string includeChildNamespaces: default: true description: Should child namespaces be included or not type: boolean required: - includeChildNamespaces type: object TestSuiteService.TestRunByQueryResult: example: tenantId: tenantId numberOfTestSuitesToBeRun: 0 numberOfTestCasesToBeRun: 6 requestMade: namespace: namespace flowId: flowId includeChildNamespaces: true results: - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 - endDate: 2000-01-23T04:56:07.000+00:00 namespace: namespace id: id testSuiteId: testSuiteId state: ERROR flowId: flowId results: - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value startDate: 2000-01-23T04:56:07.000+00:00 properties: requestMade: $ref: "#/components/schemas/TestSuiteService.RunByQueryRequest" tenantId: type: string numberOfTestSuitesToBeRun: format: int32 type: integer numberOfTestCasesToBeRun: format: int32 type: integer results: items: $ref: "#/components/schemas/TestSuiteRunResult" type: array type: object TimeWindow: properties: default: type: string max: type: string type: object Trigger: allOf: - $ref: "#/components/schemas/TriggerContext" - properties: executionId: nullable: true type: string updatedDate: format: date-time nullable: true type: string evaluateRunningDate: format: date-time nullable: true type: string workerId: nullable: true type: string type: object example: date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId type: object TriggerContext: properties: disabled: default: false type: boolean tenantId: pattern: "^[a-z0-9][a-z0-9_-]" type: string namespace: type: string flowId: type: string triggerId: type: string date: format: date-time type: string nextExecutionDate: format: date-time nullable: true type: string backfill: allOf: - $ref: "#/components/schemas/Backfill" nullable: true stopAfter: items: $ref: "#/components/schemas/State.Type" nullable: true type: array required: - date - flowId - namespace - triggerId type: object TriggerController.SetDisabledRequest: properties: triggers: items: $ref: "#/components/schemas/Trigger" minItems: 1 type: array disabled: type: boolean required: - disabled - triggers type: object TriggerController.Triggers: example: triggerContext: date: 2000-01-23T04:56:07.000+00:00 workerId: workerId nextExecutionDate: 2000-01-23T04:56:07.000+00:00 stopAfter: - CREATED - CREATED triggerId: triggerId updatedDate: 2000-01-23T04:56:07.000+00:00 executionId: executionId tenantId: tenantId namespace: namespace backfill: "" evaluateRunningDate: 2000-01-23T04:56:07.000+00:00 disabled: false flowId: flowId abstractTrigger: allowConcurrent: true stopAfter: - CREATED - CREATED description: description type: type logToFile: true version: version labels: - The_labels_to_pass_to_the_execution_created_ - The_labels_to_pass_to_the_execution_created_ failOnTriggerError: true assets: outputs: expression: expression value: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type inputs: expression: expression value: - id: id type: type - id: id type: type enableAuto: expression: expression value: true logLevel: null disabled: false id: id workerGroup: fallback: FAIL key: key conditions: - type: type - type: type properties: abstractTrigger: $ref: "#/components/schemas/AbstractTrigger" triggerContext: $ref: "#/components/schemas/Trigger" type: object TriggerFixture: example: variables: key: "{}" id: id type: type properties: id: type: string type: type: string variables: additionalProperties: type: object type: object required: - id - type type: object Type: enum: - STRING - ENUM - SELECT - INT - FLOAT - BOOLEAN - BOOL - DATETIME - DATE - TIME - DURATION - FILE - JSON - URI - SECRET - ARRAY - MULTISELECT - YAML - EMAIL type: string UnitTest: example: description: description disabled: true id: id assertions: - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 - isNotNull: expression: expression value: true in: expression: expression value: - value - value errorMessage: expression: expression value: value equalTo: expression: expression value: "{}" greaterThanOrEqualTo: expression: expression value: 0.8008281904610115 description: expression: expression value: value contains: expression: expression value: value lessThan: expression: expression value: 0.8008281904610115 isNull: expression: expression value: true endsWith: expression: expression value: value notIn: expression: expression value: - value - value value: expression: expression value: "{}" taskId: taskId lessThanOrEqualTo: expression: expression value: 0.8008281904610115 startsWith: expression: expression value: value notEqualTo: expression: expression value: "{}" greaterThan: expression: expression value: 0.8008281904610115 type: type fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value properties: id: type: string type: type: string disabled: type: boolean description: type: string fixtures: $ref: "#/components/schemas/Fixtures" assertions: items: $ref: "#/components/schemas/Assertion" type: array required: - assertions - id - type type: object UnitTestResult: example: executionId: executionId assertionResults: - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true - actual: "{}" expected: "{}" errorMessage: errorMessage description: description operator: operator taskId: taskId isSuccess: true testType: testType testId: testId state: null url: https://openapi-generator.tech errors: - details: details message: message - details: details message: message fixtures: inputs: key: "" files: key: files trigger: variables: key: "{}" id: id type: type tasks: - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value - outputs: key: "{}" assets: - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type - metadata: key: "{}" displayName: displayName namespace: namespace description: description id: id type: type description: expression: expression value: value id: id state: null value: value properties: testId: type: string testType: type: string executionId: type: string url: format: uri type: string state: $ref: "#/components/schemas/TestState" assertionResults: items: $ref: "#/components/schemas/AssertionResult" type: array errors: items: $ref: "#/components/schemas/AssertionRunError" type: array fixtures: $ref: "#/components/schemas/Fixtures" required: - assertionResults - errors - state - testId - testType type: object UserGroup: properties: value: type: string ref: type: string display: type: string type: $ref: "#/components/schemas/UserGroup.Type" type: object UserGroup.Type: enum: - DIRECT - INDIRECT type: string UserType: enum: - STANDARD - SERVICE_ACCOUNT type: string UsernamePasswordCredentials: properties: username: minLength: 1 nullable: true type: string password: minLength: 1 nullable: true type: string identity: nullable: true type: string secret: nullable: true type: string required: - password - username type: object ValidateConstraintViolation: example: filename: filename outdated: true warnings: - warnings - warnings namespace: namespace index: 0 deprecationPaths: - deprecationPaths - deprecationPaths constraints: constraints flow: flow infos: - infos - infos properties: index: format: int32 type: integer filename: type: string namespace: type: string flow: type: string constraints: type: string outdated: type: boolean deprecationPaths: items: type: string type: array warnings: items: type: string type: array infos: items: type: string type: array required: - index type: object ValuePathExpression: properties: attributePath: $ref: "#/components/schemas/AttributeReference" attributeExpression: type: object type: object WebhookResponse: example: outputs: key: "{}" flowRevision: 0 tenantId: tenantId namespace: namespace id: id trigger: variables: key: "" logFile: https://openapi-generator.tech id: id type: type state: duration: duration current: CREATED endDate: 2000-01-23T04:56:07.000+00:00 histories: - date: 2000-01-23T04:56:07.000+00:00 state: null - date: 2000-01-23T04:56:07.000+00:00 state: null startDate: 2000-01-23T04:56:07.000+00:00 flowId: flowId url: https://openapi-generator.tech labels: - value: value key: key - value: value key: key properties: tenantId: type: string id: type: string namespace: type: string flowId: type: string flowRevision: format: int32 type: integer trigger: $ref: "#/components/schemas/ExecutionTrigger" outputs: additionalProperties: type: object type: object labels: items: $ref: "#/components/schemas/Label" type: array state: $ref: "#/components/schemas/State" url: format: uri type: string type: object WorkerGroup: example: fallback: FAIL key: key properties: key: type: string fallback: $ref: "#/components/schemas/WorkerGroup.Fallback" type: object WorkerGroup.Fallback: enum: - FAIL - WAIT - CANCEL type: string WorkerTaskRestartStrategy: enum: - NEVER - IMMEDIATELY - AFTER_TERMINATION_GRACE_PERIOD type: string uploadVersionedPlugins_request: properties: file: format: binary type: string forceInstallOnExistingVersions: nullable: true type: boolean required: - file type: object setAppsCatalogLogo_request: properties: logo: description: The logo file format: binary type: string type: object bulkImportApps_request: properties: fileUpload: description: "The file to import, can be a ZIP archive or a multi-objects\ \ YAML file" format: binary type: string type: object importPluginDefaults_request: properties: fileUpload: format: binary type: string type: object createNamespaceFile_request: properties: fileContent: description: The file to upload format: binary type: string type: object deleteTriggersByQuery_request: properties: filters: description: Filters items: $ref: "#/components/schemas/QueryFilter" type: array type: object The_labels_to_pass_to_the_execution_created_: oneOf: - items: description: TODO default missing array inner type to string type: string type: array - $ref: "#/components/schemas/Map_Object.Object_" title: The labels to pass to the execution created. Flow_allOf_variables: type: object IAMRoleController_ApiRoleCreateOrUpdateRequest_permissions: example: NAMESPACE: - NAMESPACE - NAMESPACE APPEXECUTION: - APPEXECUTION - APPEXECUTION APP: - APP - APP TENANT_ACCESS: - TENANT_ACCESS - TENANT_ACCESS SERVICE_ACCOUNT: - SERVICE_ACCOUNT - SERVICE_ACCOUNT AI_COPILOT: - AI_COPILOT - AI_COPILOT BLUEPRINT: - BLUEPRINT - BLUEPRINT FLOW: - FLOW - FLOW ROLE: - ROLE - ROLE GROUP: - GROUP - GROUP DASHBOARD: - DASHBOARD - DASHBOARD IMPERSONATE: - IMPERSONATE - IMPERSONATE TEMPLATE: - TEMPLATE - TEMPLATE AUDITLOG: - AUDITLOG - AUDITLOG SETTING: - SETTING - SETTING KVSTORE: - KVSTORE - KVSTORE EXECUTION: - EXECUTION - EXECUTION ASSET: - ASSET - ASSET USER: - USER - USER GROUP_MEMBERSHIP: - GROUP_MEMBERSHIP - GROUP_MEMBERSHIP INVITATION: - INVITATION - INVITATION TEST: - TEST - TEST CREDENTIAL: - CREDENTIAL - CREDENTIAL UNKNOWN: - UNKNOWN - UNKNOWN BINDING: - BINDING - BINDING SECRET: - SECRET - SECRET properties: FLOW: items: description: TODO default missing array inner type to string type: string type: array BLUEPRINT: items: description: TODO default missing array inner type to string type: string type: array TEMPLATE: items: description: TODO default missing array inner type to string type: string type: array NAMESPACE: items: description: TODO default missing array inner type to string type: string type: array EXECUTION: items: description: TODO default missing array inner type to string type: string type: array USER: items: description: TODO default missing array inner type to string type: string type: array GROUP: items: description: TODO default missing array inner type to string type: string type: array ROLE: items: description: TODO default missing array inner type to string type: string type: array BINDING: items: description: TODO default missing array inner type to string type: string type: array AUDITLOG: items: description: TODO default missing array inner type to string type: string type: array SECRET: items: description: TODO default missing array inner type to string type: string type: array KVSTORE: items: description: TODO default missing array inner type to string type: string type: array IMPERSONATE: items: description: TODO default missing array inner type to string type: string type: array SETTING: items: description: TODO default missing array inner type to string type: string type: array APP: items: description: TODO default missing array inner type to string type: string type: array ASSET: items: description: TODO default missing array inner type to string type: string type: array APPEXECUTION: items: description: TODO default missing array inner type to string type: string type: array TEST: items: description: TODO default missing array inner type to string type: string type: array DASHBOARD: items: description: TODO default missing array inner type to string type: string type: array TENANT_ACCESS: items: description: TODO default missing array inner type to string type: string type: array SERVICE_ACCOUNT: items: description: TODO default missing array inner type to string type: string type: array INVITATION: items: description: TODO default missing array inner type to string type: string type: array GROUP_MEMBERSHIP: items: description: TODO default missing array inner type to string type: string type: array CREDENTIAL: items: description: TODO default missing array inner type to string type: string type: array AI_COPILOT: items: description: TODO default missing array inner type to string type: string type: array UNKNOWN: items: description: TODO default missing array inner type to string type: string type: array type: object Output_value: oneOf: - type: object - type: string SLA_labels: oneOf: - items: description: TODO default missing array inner type to string type: string type: array - $ref: "#/components/schemas/Map_Object.Object_" securitySchemes: basicAuth: scheme: basic type: http bearerAuth: bearerFormat: Bearer scheme: bearer type: http