docs for timezone in jobs api#5262
Open
cicoyle wants to merge 1 commit into
Open
Conversation
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Jobs API reference documentation to clarify payload semantics and how schedules behave with timezones, helping users create predictable schedules (including across DST transitions).
Changes:
- Clarifies the
datarequest field as optional and describes when it’s delivered to the app. - Documents timezone pinning for
scheduleviaCRON_TZ=/TZ=prefixes, including DST behavior and validation rules.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+65
to
+66
| By default, a `schedule` is evaluated in the local timezone of the Dapr scheduler | ||
| service. To pin a job to a specific timezone instead, prefix the schedule with |
Comment on lines
+87
to
+88
| fire at a fixed interval rather than at a wall-clock time, so there is no wall | ||
| clock for a timezone to apply to, and the job is rejected when it is scheduled. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs for this PR & from this one in kit on parsing the schedule