Skip to content

Improve Reliable Tasking extension documentation#302

Merged
maximelb merged 1 commit into
masterfrom
reliable-tasking-doc-improvements
Jul 11, 2026
Merged

Improve Reliable Tasking extension documentation#302
maximelb merged 1 commit into
masterfrom
reliable-tasking-doc-improvements

Conversation

@maximelb

Copy link
Copy Markdown
Contributor

Summary

Expands and corrects the Reliable Tasking extension page based on the extension's actual behavior, prompted by customer questions about TTL semantics, untask, and large fan-outs.

  • New "How It Works" section — queue lifecycle: delivery only happens while a sensor is connected, TTL is evaluated at each delivery attempt (a sensor reconnecting after expiry never receives the task), tasks are removed on receipt confirmation, and restart/upgrade_core are confirmed on send since they emit no receipt.
  • Fixed targeting documentation — the page claimed omitting selector sends the task to all sensors; the extension actually requires one of sid/tag/selector and rejects the request otherwise. Now documents all three (the tag parameter was previously undocumented) and "*" to target all sensors.
  • Documented the task action response (task_id, total_sensors, tasked_sensors, queued_sensors).
  • New untask section — API examples, parameters, the deleted count response, and semantics (queued tasks are reliably cancelled; already-delivered tasks cannot be recalled).
  • New "TTL and Delivery Guarantees" section — no minimum TTL, expiry checked at delivery time, the recommended pattern for bounding task delivery to a deadline, and the late-receipt caveat.
  • New "Monitoring Task Delivery" section — documents the previously-undocumented feedback events (add_task, try_task, task_sent, task_done, task_failure) emitted via the auto-installed ext-reliable-tasking webhook adapter, with a D&R example.
  • New "Fanning Out at Scale" section — a single request with a tag/selector fans out server-side, plus HTTP 429 / X-RateLimit-* header behavior.
  • Corrected the stale list-action note (it scopes by sensor via sid/tag/selector, defaulting to *) and fixed code fence languages.

Testing

  • npx markdownlint-cli2 passes on the modified file (0 errors).

🤖 Generated with Claude Code

https://claude.ai/code/session_0174UgLr8Bwp16estNd9TQio

- Add "How It Works" lifecycle section: delivery only while connected,
  TTL evaluated at delivery time, receipt-based confirmation
- Fix targeting docs: one of sid/tag/selector is required (omitting the
  selector does not task all sensors; use "*" for that), document tag
- Document the task action response fields (task_id, total_sensors,
  tasked_sensors, queued_sensors)
- Add untask API documentation with examples, parameters and semantics
- Add "TTL and Delivery Guarantees" section with the timeout pattern
  and late-receipt caveat
- Document the delivery feedback events emitted through the
  ext-reliable-tasking webhook adapter, with a D&R example
- Add "Fanning Out at Scale" section: server-side fan-out via selector,
  429 behavior and X-RateLimit-* headers
- Correct the stale list-action note and code fence languages

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174UgLr8Bwp16estNd9TQio
@maximelb maximelb merged commit bc7a440 into master Jul 11, 2026
7 checks passed
@maximelb maximelb deleted the reliable-tasking-doc-improvements branch July 11, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants