Repository navigation
docs: fix Cron Jobs button location, run statuses, and document cron API - #597
HarshRajSinghania wants to merge 3 commits into
Conversation
|
Thanks @HarshRajSinghania for picking up #587. This PR fixes the Cron button location and the run-status table on the Cron Jobs wiki page, and adds a cron route table to the HTTP API wiki page. The button location, the five status names, the route list and the required create fields all match the code. A few things need to change before it can merge: 1. 2. 3. Run-status meanings,
4. Response shapes, 5. Unrelated table edits in Once 1 and 2 are in, this is ready to merge. Items 3 to 5 are small: push them with the rest, or leave them and I will apply them at merge time. I will squash the commits on merge, so there is no need to rewrite history. |
|
Thanks again @HarshRajSinghania for picking up #587, and sorry for the mixed signal: I'm closing this one as a duplicate of #589. #589 was opened about four hours before this PR, also with Your verification against |
Summary
Addresses the documentation gaps in Cron Jobs described in #587.
Changes
session_startedandprompt_sentstatuses to the run history table, with a note that history tracks session start and prompt delivery, not task success./api/cronroutes, methods, and brief notes on request validation and run statuses.Motivation
Issue #587 identified three specific gaps: incorrect button description, incomplete status list, and undocumented cron API routes. The facts were verified against the current code (
src/web/public/index.html,src/types/cron.ts,src/web/routes/cron-routes.ts).Testing
CronJobRunStatusinsrc/types/cron.ts.src/web/routes/cron-routes.ts.No runtime tests were run, as this is a documentation-only change.
Fixes #587