Skip to content

Commit ad00205

Browse files
author
Alan Christie
committed
docs: Add instance-directory comment
1 parent da12869 commit ad00205

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

workflow/workflow_abc.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,12 @@ def get_running_workflow_step(
240240
# }
241241
# If not present an empty dictionary should be returned.
242242
#
243+
# Additionally, if the step has started (an instance has been created)
244+
# the response will contain a "instance_directory" top-level property
245+
# that is the directory within the Project that's the step's working directory.
246+
#
247+
# "instance_directory": ".instance-00000000-0000-0000-0000-00000000000a",
248+
#
243249
# For steps that are not the first in a workflow the following field
244250
# can be expected in the response: -
245251
#
@@ -273,6 +279,12 @@ def get_running_workflow_step_by_name(
273279
# }
274280
# If not present an empty dictionary should be returned.
275281
#
282+
# Additionally, if the step has started (an instance has been created)
283+
# the response will contain a "instance_directory" top-level property
284+
# that is the directory within the Project that's the step's working directory.
285+
#
286+
# "instance_directory": ".instance-00000000-0000-0000-0000-00000000000a",
287+
#
276288
# For steps that are not the first in a workflow the following field
277289
# can be expected in the response: -
278290
#
@@ -322,6 +334,12 @@ def get_workflow_steps_driving_this_step(
322334
# }
323335
# ]
324336
# }
337+
#
338+
# Additionally, if the step has started (an instance has been created)
339+
# each entry on the array of steps will contain a "instance_directory" property
340+
# that is the directory within the Project that's the step's working directory.
341+
#
342+
# "instance_directory": ".instance-00000000-0000-0000-0000-00000000000a",
325343

326344
@abstractmethod
327345
def get_instance(self, *, instance_id: str) -> tuple[dict[str, Any], int]:

0 commit comments

Comments
 (0)