Merge pull request #23377 from NiekRossenInfoSupport/feature/document-template-conditionals

Add examples for using parameters as conditionals and setting parameters
2024-03-05 12:00:39 +01:00
parent 7b896d61ad db8a448075
commit 900ca70831
1 changed files with 44 additions and 0 deletions
@@ -194,3 +194,47 @@ parameters:
  input:
    message: 'production step'
 ```
+
+## Use parameters as conditional for fields
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      includeName:
+        title: Include Name?
+        type: boolean
+        default: true
+
+    dependencies:
+      includeName:
+        allOf:
+          - if:
+              properties:
+                includeName:
+                  const: true
+            then:
+              properties:
+                lastName:
+                  title: Last Name
+                  type: string
+```
+
+## Conditionally set parameters
+
+```yaml
+spec:
+  parameters:
+    - title: Fill in some steps
+      properties:
+        path:
+          title: path
+          type: string
+
+  steps:
+    - id: fetch
+      name: Fetch template
+      action: fetch:template
+      input:
+        url: ${{ parameters.path if parameters.path else '/root' }}
+```