Merge pull request #163 from bento-platform/feat/workflows/help-text

feat(workflows): add help text field to workflow input base model
bento-platform · Dec 6, 2023 · 8b51054 · 8b51054
2 parents 4f44782 + 2b61e34
commit 8b51054
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/bento_lib/package.cfg b/bento_lib/package.cfg
@@ -1,5 +1,5 @@
 [package]
 name = bento_lib
-version = 11.0.0a2
+version = 11.0.0a3
 authors = David Lougheed, Paul Pillot
 author_emails = [email protected], [email protected]
diff --git a/bento_lib/workflows/models.py b/bento_lib/workflows/models.py
@@ -36,6 +36,7 @@ class WorkflowBaseInput(FrozenBaseModel):
     id: str
     required: bool = True
     type: str
+    help: str = ""  # Help text to render alongside fields in GUI forms.
 
 
 class WorkflowInjectedInput(WorkflowBaseInput):

diff --git a/tests/common.py b/tests/common.py
@@ -40,6 +40,6 @@
     description="A test workflow",
     file="test.wdl",
     inputs=[
-        workflows.models.WorkflowStringInput(id="input1", type="string"),
+        workflows.models.WorkflowStringInput(id="input1", type="string", help="Some string input"),
     ]
 )