ac41f94d11
* For the sake of the service performance, it may make sense to
disable validation of the workflow language syntax if it is
affordable for a particular use case. For example, if all
workflows are auto-generated by a 3rd party system and tested
thoroughly (either by running them with Mistral or at least
validating them via the special Mistral endpoint) then we can
safely disable validation of the language syntax when uploading
workflow definitions. For production systems it makes a big
difference if workflow texts are large (thousands of tasks).
This patch adds the boolean parameter "skip_validation" for API
requests like "POST /v2/workflows" to disable validation, if
needed, and the new configuration property "validation_mode"
to set a desired validation mode.
The option is an enumeration and has the following valid values:
1) "enabled" - enabled for all API requests unless it's
explicitly disabled in the request itself
2) "mandatory" - enabled for all API requests regardless
of the flag in the request
3) "disabled" - disabled for all API requrests regardless
of the flag in the request
"mandatory" is choosen as the default value for this new
property to keep compatibility with the previous versions.
* Minor style changes.
Closes-Bug: #1844242
Change-Id: Ib509653d38254954f8449be3031457e5f636ccf2
19 lines
1.1 KiB
YAML
19 lines
1.1 KiB
YAML
---
|
|
features:
|
|
- |
|
|
The new configuration option "validation_mode" was added. It can take one
|
|
of the values: "enabled", "mandatory", "disabled". If it is set to
|
|
"enabled" then Mistral will be validating the workflow language syntax
|
|
for all API operations that create or update workflows (either via
|
|
/v2/workflows or /v2/workbooks) unless it's explicitly disabled with the
|
|
API parameter "skip_validation" that has now been added to the
|
|
corresponding API endpoints. The "skip_validation" parameter doesn't have
|
|
to have any value since it's a boolean flag. If the configuration option
|
|
"validation_mode" is set to "mandatory" then Mistral will be always
|
|
validating the syntax of all workflows for the mentioned operations.
|
|
If set to "disabled" then validation will always be skipped. Note that
|
|
if validation is disabled (one way or another) then there's a risk of
|
|
breaking a workflow unexpectedly while it's running or getting another an
|
|
unexpected error when uploading it possible w/o a user-friendly description
|
|
of the error.
|