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

[ricardozanini]

Summary

• Adds a read property to the schedule definition as a sibling of on
• Allows users to choose how consumed events are read when a workflow is triggered by events (data, envelope, or raw)
• Defaults to data, making this a non-breaking change
• Mirrors the existing listen.read property for consistency

Example

schedule:
  on:
    one:
      with:
        type: com.example.order-placed
  read: envelope

Fixes #1177

[Copilot]

Pull request overview

This PR extends the workflow scheduling schema and documentation to allow configuring how events are materialized into workflow inputs when a workflow is triggered via schedule.on, aligning behavior with the existing listen.read option.

Changes:

• Adds schedule.read to the JSON schema with data|envelope|raw and default data.
• Documents the new schedule.read property in the DSL reference.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
schema/workflow.yaml	Adds schedule.read schema property (enum + default) to control event reading mode for event-triggered schedules.
dsl-reference.md	Documents schedule.read and its supported values/default.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

schema/workflow.yaml:159

• The schema property name is schedule.read, but the title is ScheduleOnReadAs, which implies the property is nested under on. For consistency with other schedule property titles (e.g., ScheduleCron, ScheduleOn), consider renaming this title to reflect the actual property (ScheduleReadAs).

        title: ScheduleOnReadAs

[cdavernas]

LGTM! Cheers ❤️

[cdavernas]

LGTM!

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

schema/workflow.yaml:159

• The title for the schedule.read property breaks the naming pattern used by other schedule properties (ScheduleEvery, ScheduleCron, ScheduleAfter, ScheduleOn). Since the property name is read, using ScheduleOnReadAs is inconsistent and may make schema validation messages confusing.

        title: ScheduleOnReadAs

schema/workflow.yaml:160

• The schedule.read schema duplicates the exact same enum/default as listen.read. To avoid divergence over time, consider extracting this into a shared $defs schema (e.g., eventReadAs) and referencing it from both schedule.read and listen.read.

      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'.