Skip to content

Commit c120675

Browse files
author
Alan Christie
committed
docs: Doc tweak
1 parent 77b06d5 commit c120675

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

workflow/workflow_abc.py

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,16 @@ def get_running_workflow(
112112
# "success": false,
113113
# "error": None,
114114
# "error_msg": None,
115-
# "workflow": {"id": "workflow-000"},
116-
# "project_id": "project-000",
117-
# "variables": {"x": 1, "y": 2},
115+
# "workflow": {
116+
# "id": "workflow-000",
117+
# },
118+
# "project": {
119+
# "id": "project-000",
120+
# },
121+
# "variables": {
122+
# "x": 1,
123+
# "y": 2,
124+
# },
118125
# }
119126
# }
120127
# If not present an empty dictionary should be returned.
@@ -157,7 +164,9 @@ def get_running_workflow_step(
157164
# "success": false,
158165
# "error": None,
159166
# "error_msg": None,
160-
# "running_workflow": "r-workflow-00000000-0000-0000-0000-000000000001",
167+
# "running_workflow": {
168+
# "id": "r-workflow-00000000-0000-0000-0000-000000000001"
169+
# },
161170
# },
162171
# }
163172
# If not present an empty dictionary should be returned.
@@ -177,9 +186,13 @@ def set_running_workflow_step_done(
177186
@abstractmethod
178187
def get_instance(self, *, instance_id: str) -> tuple[dict[str, Any], int]:
179188
"""Get an Instance Record"""
180-
# Should return:
189+
# For a RunningWorkflowStep Instance it should return:
181190
# {
182-
# "running_workflow_step": "r-workflow-step-00000000-0000-0000-0000-000000000001",
191+
# "id": "instance-00000000-0000-0000-0000-000000000001",
192+
# "running_workflow_step": {
193+
# "id": "r-workflow-step-00000000-0000-0000-0000-000000000001",
194+
# "step": "step-1234",
195+
# },
183196
# [...],
184197
# }
185198
# If not present an empty dictionary should be returned.

0 commit comments

Comments
 (0)