Repository navigation
docs(cron): document job API and launch statuses - #589
Conversation
I corrected the toolbar location and documented the existing cron request and response fields, with checks for route, schema, and status coverage.
|
Great thanks and welcome :-) |
|
Thanks a lot @w3lld1, and welcome! This PR fixes the Cron button location and settings path on the Cron Jobs page, fills in the two missing run statuses, documents all nine cron endpoints in the API reference and the HTTP API wiki page, and adds a test that keeps those docs tied to the routes, the schema and the status type. I checked every claim against A few small things:
Optional nits, take them or leave them:
None of this blocks the PR. I am happy to apply these on top at merge time, or you can push them here first if you prefer, and then it goes in. |
Signed-off-by: w3lld1 <42353747+w3lld1@users.noreply.github.com>
|
Addressed the three follow-up points and the optional nits in 34439d1:
Fresh checks on the committed head:
The five documented static gates also passed: typecheck, lint, format:check, check:frontend-syntax, and check:browser-excludes. Dependencies were installed with AI disclosure: this follow-up was generated and checked by Hermes using OpenAI gpt-6.1-sol; it is not a claim of personal human verification. |
|
Merged, thank you @w3lld1! This closes #587, and the wiki pages go live on the GitHub wiki with this push (the wiki sync runs on every master push that touches What made this an easy merge: every claim checks out against A related PR (#597) also targeted #587; it was closed as a duplicate of this one, since yours came first and covered more. Thanks as well for the clear validation notes and the AI disclosure: knowing exactly what was and wasn't run locally made the review faster. |
Summary
I corrected the Cron button's location and settings path, filled in the two missing run statuses, and clarified that launch/prompt-delivery history does not report task success.
I documented all nine existing cron endpoints in the API reference and wiki, including request fields, response payloads, versioned aliases, partial updates, ownership restrictions, and asynchronous prompt delivery. I also added documentation checks against the route declarations, job schema, and status type. I did not change runtime behavior.
Fixes #587
Validation
I ran:
npm test -- test/cron-docs.test.ts test/cron-time.test.ts— 17 tests passed across two files, including three new documentation checks.npm run typechecknpm run lintnpm run format:checknpm run check:frontend-syntaxnpm run check:browser-excludesnpx prettier --check test/cron-docs.test.tsgit diff --check origin/master...HEADMy initial
npm cistopped while node-gyp extracted node-pty's Node headers (fchown: EINVAL). I installed dependencies withnpm ci --ignore-scriptsfor the checks above. I left the full unit/integration suite, native dependency build, and server boot smoke test to upstream CI; I am not claiming they passed locally.