diff --git a/Docs/Dev/en/specification.md b/Docs/Dev/en/specification.md new file mode 100644 index 0000000..bcc4ac1 --- /dev/null +++ b/Docs/Dev/en/specification.md @@ -0,0 +1,60 @@ +# Specification + +```json +{ + "steps": [ + { + "name": "step-name", + "event-name": "unique-event-name-generated-on-upload", + "type": 1, + "template": "visual-template", + "users": [], + "groups": [], + "event-listeners": [ + "event-to-listen-for-1" + "event-to-listen-for-2" + ], + "pre": { + "event-trigger": [ + "event-to-trigger-1" + "event-to-trigger-2" + ], + "script": [ + "script-to-run-1" + "script-to-run-2" + ] + }, + "post": { + "event-trigger": [ + "event-to-trigger-1" + "event-to-trigger-2" + ], + "script": [ + "script-to-run-1" + "script-to-run-2" + ] + } + }, + { + .... + } + ] +} +``` + +Good synergy with job module required... job runs every x and might invoke a workflow/workflow-step + +## Type + +* 1 = Autorun after previous event +* 2 = Only if event listener is called + +Every step receives the status code of all steps + the custom data created from the previous steps + +After every step the handler writes custom data to the workflow run information. + +This means every workflow has a configuration and whenever a new workflow get's triggered a new "workflow entry" is created. + +## Template + +e.g. user interface for this step \ No newline at end of file diff --git a/composer.json b/composer.json index 7ad134b..7cf5769 100755 --- a/composer.json +++ b/composer.json @@ -10,7 +10,7 @@ "require-dev": { "phpunit/phpunit": ">=9.4", "friendsofphp/php-cs-fixer": ">=3.0", - "squizlabs/php_codesniffer": ">=3.5", + "squizlabs/php_codesniffer": ">=3.6", "phpmd/phpmd": ">=2.9", "phpstan/phpstan": ">=0.12.58", "phan/phan": ">=3.2.6"