|
2723 | 2723 | "type": "object" |
2724 | 2724 | }, |
2725 | 2725 | "EmptyStage": { |
2726 | | - "description": "Empty stage for logging and debugging workflows.\n\nEmptyStage is a utility stage that performs no actual work but provides\nlogging output and optional delays. It's commonly used for:\n- Debugging workflow execution flow\n- Adding informational messages to workflows\n- Creating delays between stages\n- Testing template parameter resolution\n\nThe stage outputs the echo message to stdout and can optionally sleep\nfor a specified duration, making it useful for workflow timing control\nand debugging scenarios.\n\nAttributes:\n echo (str, optional): Message to display during execution\n sleep (float): Duration to sleep after logging (0-1800 seconds)\n\nExample:\n ```yaml\n stages:\n - name: \"Workflow Started\"\n echo: \"Beginning data processing workflow\"\n sleep: 2\n\n - name: \"Debug Parameters\"\n echo: \"Processing file: ${{ params.filename }}\"\n ```\n\n ```python\n stage = EmptyStage(\n name=\"Status Update\",\n echo=\"Processing completed successfully\",\n sleep=1.0\n )\n ```", |
| 2726 | + "description": "Empty stage for logging and debugging workflows.\n\nEmptyStage is a utility stage that performs no actual work but provides\nlogging output and optional delays. It's commonly used for:\n - Debugging workflow execution flow\n - Adding informational messages to workflows\n - Creating delays between stages\n - Testing template parameter resolution\n\nThe stage outputs the echo message to stdout and can optionally sleep\nfor a specified duration, making it useful for workflow timing control\nand debugging scenarios.\n\nExample:\n ```yaml\n stages:\n - name: \"Workflow Started\"\n echo: \"Beginning data processing workflow\"\n sleep: 2\n\n - name: \"Debug Parameters\"\n echo: \"Processing file: ${{ params.filename }}\"\n ```\n\n >>> stage = EmptyStage(\n ... name=\"Status Update\",\n ... echo=\"Processing completed successfully\",\n ... sleep=1.0\n ... )", |
2727 | 2727 | "properties": { |
2728 | 2728 | "extras": { |
2729 | 2729 | "additionalProperties": true, |
|
2788 | 2788 | } |
2789 | 2789 | ], |
2790 | 2790 | "default": null, |
2791 | | - "description": "A message that want to show on the stdout.", |
| 2791 | + "description": "A message that want to display on the stdout during execution. By default, it do not show any message.", |
2792 | 2792 | "title": "Echo" |
2793 | 2793 | }, |
2794 | 2794 | "sleep": { |
2795 | 2795 | "default": 0, |
2796 | | - "description": "A second value to sleep before start execution. This value should gather or equal 0, and less than 1800 seconds.", |
| 2796 | + "description": "A duration in second value to sleep after logging. This value should between 0 - 1800 seconds.", |
2797 | 2797 | "exclusiveMaximum": 1800, |
2798 | 2798 | "minimum": 0, |
2799 | 2799 | "title": "Sleep", |
|
3950 | 3950 | "type": "object" |
3951 | 3951 | }, |
3952 | 3952 | "TriggerStage": { |
3953 | | - "description": "Trigger workflow executor stage that run an input trigger Workflow\nexecute method. This is the stage that allow you to create the reusable\nWorkflow template with dynamic parameters.\n\nData Validate:\n >>> stage = {\n ... \"name\": \"Trigger workflow stage execution\",\n ... \"trigger\": 'workflow-name-for-loader',\n ... \"params\": {\"run-date\": \"2024-08-01\", \"source\": \"src\"},\n ... }", |
| 3953 | + "description": "Trigger workflow executor stage that run an input trigger Workflow\nexecute method. This is the stage that allow you to create the reusable\nWorkflow template with dynamic parameters.\n\n This stage does not allow to pass the workflow model directly to the\ntrigger field. A trigger workflow name should exist on the config path only.\n\nData Validate:\n >>> stage = {\n ... \"name\": \"Trigger workflow stage execution\",\n ... \"trigger\": 'workflow-name-for-loader',\n ... \"params\": {\"run-date\": \"2024-08-01\", \"source\": \"src\"},\n ... }", |
3954 | 3954 | "properties": { |
3955 | 3955 | "extras": { |
3956 | 3956 | "additionalProperties": true, |
|
4256 | 4256 | }, |
4257 | 4257 | "version": { |
4258 | 4258 | "default": "3.9", |
4259 | | - "description": "A Python version that want to run.", |
| 4259 | + "description": "A Python version that want to run. It will use supported version of this package by default, 3.9.", |
4260 | 4260 | "title": "Version", |
4261 | 4261 | "type": "string" |
4262 | 4262 | }, |
|
4299 | 4299 | "description": "A workflow name.", |
4300 | 4300 | "title": "Name" |
4301 | 4301 | }, |
| 4302 | + "type": { |
| 4303 | + "const": "Workflow", |
| 4304 | + "description": "A type of workflow template that should be `Workflow`.", |
| 4305 | + "title": "Type", |
| 4306 | + "type": "string" |
| 4307 | + }, |
4302 | 4308 | "desc": { |
4303 | 4309 | "anyOf": [ |
4304 | 4310 | { |
|
4404 | 4410 | "format": "date-time", |
4405 | 4411 | "title": "Updated Dt", |
4406 | 4412 | "type": "string" |
4407 | | - }, |
4408 | | - "type": { |
4409 | | - "const": "Workflow", |
4410 | | - "description": "A type of workflow template.", |
4411 | | - "title": "Type", |
4412 | | - "type": "string" |
4413 | 4413 | } |
4414 | 4414 | }, |
| 4415 | + "required": [ |
| 4416 | + "type" |
| 4417 | + ], |
4415 | 4418 | "title": "WorkflowSchema", |
4416 | 4419 | "type": "object" |
4417 | 4420 | } |
|
0 commit comments