Fix alarm trigger docs: use ISO-8601 dates, clarify timezone is ignored#489
Merged
Fix alarm trigger docs: use ISO-8601 dates, clarify timezone is ignored#489
Conversation
The startDate and stopDate parameters for /whisk.system/alarms/alarm must use ISO-8601 format (e.g. "2026-03-01T00:00:00.000Z"). Epoch millisecond timestamps cause a 502 Bad Gateway error on deploy. Also clarifies that the timezone parameter is ignored and cron expressions are always evaluated in UTC. See: https://jira.corp.adobe.com/browse/RUNNER-8924
The repo linter requires InlineAlert to be self-closing with content on the following lines, not wrapped in opening/closing tags.
purplecabbage
approved these changes
Mar 3, 2026
Contributor
purplecabbage
left a comment
purplecabbage
left a comment
There was a problem hiding this comment.
You could future-proof the docs even more if you chose a more distant future date for your example ... assuming ai has not taken over by then 😛
riddhi2910
approved these changes
Mar 3, 2026
Member
|
The |
dthampy
approved these changes
Mar 3, 2026
Tested and confirmed that ISO-8601 timezone offsets (e.g. +05:30) in startDate/stopDate are correctly parsed and honored. Updated the docs to make clear that while cron is always UTC, the date params accept any valid ISO-8601 with offsets.
shazron
approved these changes
Mar 3, 2026
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
5 participants
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.
Summary
Fixes documentation for the
/whisk.system/alarms/alarmfeed to prevent 502 deployment errors.Changes:
cron-jobs/lesson3.md: Replaced broken epoch millisecond timestamp example with ISO-8601 format. Added anInlineAlertnoting thattimezoneis ignored (cron is always evaluated in UTC),startDate/stopDatemust use ISO-8601, and both dates must be in the future.prepackages.md: Added anInlineAlertwith the same guidance on date format and timezone. Updated the cron trigger CLI example to use future ISO-8601 dates.Context
Customers following the Lesson 3 cron jobs tutorial were hitting HTTP 502 (Bad Gateway) errors on deploy because the example used epoch millisecond timestamps (
1601918992704), which are not supported by the alarms provider. The example dates were also from 2020, which would fail regardless since dates must be in the future.Tested and confirmed:
startDate/stopDate→ 502 error (with or withouttimezone)startDate/stopDate→ deploys successfullySee: RUNNER-8924
Test plan
InlineAlertcomponents render correctly on the dev site