Updates both the DSL reference and schema to include script arguments

Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>
serverlessworkflow · Aug 7, 2024 · fd0d67f · fd0d67f
1 parent 151392d
commit fd0d67f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/dsl-reference.md b/dsl-reference.md
@@ -786,7 +786,8 @@ Enables the execution of custom scripts or code within a workflow, empowering wo
 | language | `string` | `yes` | The language of the script to run |
 | code | `string` | `no` | The script's code.<br>*Required if `source` has not been set.* |
 | source | [externalResource](#external-resource) | `no` | The script's resource.<br>*Required if `code` has not been set.* |
-| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured process |
+| arguments | `map` | `no` | A list of the arguments of the script to run |
+| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured script process |
 
 ###### Examples
 
@@ -801,8 +802,10 @@ do:
       run:
         script:
           language: js
+          arguments:
+            greetings: Hello, world!
           code: >
-            Some cool multiline script
+            console.log(greetings)
 ```
 
 ##### Shell Process

diff --git a/schema/workflow.yaml b/schema/workflow.yaml
@@ -508,11 +508,16 @@ $defs:
                   language:
                     type: string
                     description: The language of the script to run.
+                  arguments:
+                    title: ScriptArguments
+                    type: object
+                    additionalProperties: true
+                    description: A key/value mapping of the arguments, if any, to use when running the configured script.
                   environment:
                     title: ScriptEnvironment
                     type: object
                     additionalProperties: true
-                    description: A key/value mapping of the environment variables, if any, to use when running the configured process.
+                    description: A key/value mapping of the environment variables, if any, to use when running the configured script process.
                 oneOf:
                   - title: ScriptInline
                     properties: