Skip to content

docs(rf-api): add bounded polling for async jobs - #15

Merged
manykarim merged 5 commits into
MarketSquare:mainfrom
ai94iq:docs/bounded-polling
Nov 17, 2026
Merged

manykarim merged 5 commits into
MarketSquare:mainfrom
ai94iq:docs/bounded-polling

Conversation

@ai94iq

@ai94iq ai94iq commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Adds an async job reference to rf-requests: wait for a job with a time-bound poll, not a fixed Sleep.

Verified: the example passes robot --dryrun on Robot Framework 7.5.1 with RequestsLibrary 0.9.7. Catalog, governance, plugin references and docs voice checks pass.

What this changes

The poll lives in a keyword, uses limit=60s with a short pause between calls, and fails with a message on timeout. Builds on #13, so merge #13 first.

Review checklist

Tick each item, or write "n/a: " after it. Reviewers don't approve a PR
with an unticked item that has no reason (see CONTRIBUTING.md, "Review").

  • Purpose. Each new or changed skill and subagent says what it is for and when to use it, in its description. n/a: no skill description change, only a new reference
  • Supported versions. catalog.yaml lists the libraries and version ranges the content was checked against, and the Robot Framework range. n/a: no new library, catalog.yaml is unchanged
  • Examples. .robot examples pass robot --dryrun; Python examples run.
  • Security-relevant changes. Hooks, scripts, MCP configuration, manifests, subagent tools and skill allowed-tools changes are listed below; the security gate passes, and any new baseline entry has a reason. n/a: no hook, script, manifest or tools change
  • Tool permissions. Every subagent declares an explicit tools list; no allowed-tools entry grants unrestricted shell access. n/a: no subagent or allowed-tools change
  • Documentation voice. Text follows the writing rules in CONTRIBUTING.md and passes the docs voice check.

Security-relevant changes

none

Add a reference that waits for an async API job with a bounded WHILE
loop instead of Sleep. The rf-requests SKILL.md links to it.
Both branches add one row to the rf-requests reference table. Kept both
rows so the branches merge cleanly in order. Plugin and bundle copies
match (cmp).
@ai94iq
ai94iq requested a review from manykarim as a code owner November 15, 2026 07:48
@ai94iq ai94iq changed the title Docs/bounded polling docs(rf-api): add bounded polling for async jobs Nov 15, 2026
async-jobs.md: limit=60s instead of an iteration count, a short Sleep
between polls, the WHILE loop moved into a keyword, $state expression
form, and the version note corrected (limit since RF 5.0,
on_limit_message since RF 6.1). Plugin and bundle copies match (cmp).
@ai94iq

ai94iq commented Nov 15, 2026

Copy link
Copy Markdown
Contributor Author

Merge chain: #11, then #12, then #13, then #14, then #15, then #16.

All six merge into main cleanly in this order (dry run on 2026-11-15).

This one depends on #13: both change the same table in the rf-requests SKILL.md. The branch already has #13 merged in, so its diff shows #13 changes until #13 lands.

Apart from #13 and #15, the PRs do not depend on each other.

manykarim and others added 2 commits November 17, 2026 14:31
The example pauses 2s between polls, so "no Sleep" read as the opposite.
Regenerated with python scripts/build-catalog.py.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FHEmzL3ErAhGQykKWDx2wP
@manykarim
manykarim merged commit d5a1e91 into MarketSquare:main Nov 17, 2026
26 checks passed
@manykarim

Copy link
Copy Markdown
Collaborator

Thanks, @ai94iq! 🎉 A bounded poll is exactly the right advice for async jobs, and the example is correct: limit=60s is a time limit, and on_limit_message works on the Robot Framework 7.0+ that rf-api supports. Nice that you dry-ran it too.

I made a few small changes so I could merge it right away:

  • merged docs(rf-api): add loose-assertion anti-patterns #13 first, then the current main into your branch, so this PR now only adds async-jobs.md and its rows;
  • changed the quick-reference row in plugins/rf-api/skills/rf-requests/SKILL.md from "no Sleep" to "bounded WHILE poll with a short pause, no fixed Sleep", to match the example's 2s pause between polls;
  • regenerated the bundle with python scripts/build-catalog.py.

All checks passed, and it's merged now.

One small note for future PRs: since you opened this, we published AI_POLICY.md, and the PR template now has an "AI assistance" section. On new PRs we'd love a line there whenever a tool did a substantial part of the work, plus the command that regenerated bundles/.

Thanks again!

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