Skip to content

[Fix #1177] Add read property to schedule.on #1178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ricardozanini merged 3 commits into from
Jul 29, 2026
+9 −0
Merged

[Fix #1177] Add read property to schedule.on #1178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6de7a2b
[Fix #1177] Add read property to schedule.on
ricardozanini Jul 29, 2026
50c5d69
Require schedule.on when read is specified
ricardozanini Jul 29, 2026
7cdd531
Document that schedule.read requires on to be set
ricardozanini Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dsl-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ Configures the schedule of a workflow.
| cron | `string` | `no` | Specifies the schedule using a CRON expression, e.g., '0 0 * * *' for daily at midnight.<br>*Required when no other property has been set.* |
| after | [`duration`](#duration) | `no` | Specifies a delay duration that the workflow must wait before starting again after it completes. In other words, when this workflow completes, it should run again after the specified amount of time.<br>*Required when no other property has been set.* |
| on | [`eventConsumptionStrategy`](#event-consumption-strategy) | `no` | Specifies the events that trigger the workflow execution.<br>*Required when no other property has been set.* |
| read | `string` | `no` | Specifies how [events](https://cloudevents.io/) are read when the workflow is triggered by events.<br>*Supported values are:*<br>*- `data`: Reads the [event's](https://cloudevents.io/) data.*<br>*- `envelope`: Reads the [event's](https://cloudevents.io/) envelope, including its [context attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#context-attributes).*<br>*- `raw`: Reads the [event's](https://cloudevents.io/) raw data.*<br>*Defaults to `data`.*<br>*Can only be set when `on` is defined. If set without `on`, the workflow MUST be considered invalid by the runtime.* |

#### Evaluate

Expand Down
8 changes: 8 additions & 0 deletions schema/workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,14 @@ properties:
$ref: '#/$defs/eventConsumptionStrategy'
title: ScheduleOn
description: Specifies the events that trigger the workflow execution.
read:
type: string
enum: [ data, envelope, raw ]
default: data
title: ScheduleOnReadAs
description: Specifies how consumed events are read when the workflow is triggered by events. Supported values are 'data' (reads the event's data), 'envelope' (reads the event's envelope, including context attributes), and 'raw' (reads the event's raw data). Defaults to 'data'.
dependentRequired:
read: [ on ]
evaluate:
type: object
title: Evaluate
Expand Down
Loading