Skip to content

Document activity search filter #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Thanhdn1984 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

Document activity search filter #536

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/agent-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Inspect one bounty, accepted-work activity, a ledger page, and a proof:
curl -s "$API_HOST/api/v1/bounties/<bounty_id>"
curl -s "$API_HOST/api/v1/bounties/<bounty_id>/attempts"
curl -s "$API_HOST/api/v1/activity"
curl -s "$API_HOST/api/v1/activity?q=<account-or-pr-or-proof>"
curl -s "$API_HOST/api/v1/ledger?limit=10"
curl -s "$API_HOST/api/v1/proofs/<proof_hash>"
```
Expand All @@ -67,6 +68,10 @@ curl -s "$API_HOST/api/v1/ledger/1"
The `<bounty_id>` value is the internal MergeWork bounty id returned by
`/api/v1/bounties`, not the GitHub issue number.

`/api/v1/activity` accepts optional `q` text search. It filters accepted-work
rows by account, amount, submission reference, bounty reference, issue URL, PR
URL, proof hash, or note; the HTML `/activity` page uses the same filter.
Comment on lines +71 to +73
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Remove unsupported note filter claim from /api/v1/activity docs.

The implementation does not search a note field. Current matching is against account, amount_mrwk, submission_url, proof_hash, bounty_id, bounty_repo, bounty_issue_url, and bounty_issue_number (app/serializers.py, _activity_row_matches). Please update this sentence to avoid documenting behavior that does not exist.

Proposed doc fix 
-`/api/v1/activity` accepts optional `q` text search. It filters accepted-work
-rows by account, amount, submission reference, bounty reference, issue URL, PR
-URL, proof hash, or note; the HTML `/activity` page uses the same filter.
+`/api/v1/activity` accepts optional `q` text search. It filters accepted-work
+rows by account, amount, submission/PR reference, bounty id or repo, issue URL
+or issue number, and proof hash; the HTML `/activity` page uses the same filter.

As per coding guidelines, docs under docs/**/*.md must be short, concrete, and avoid unsupported/speculative claims.


Before opening a bounty PR, sign in with GitHub and register a short-lived
advisory attempt so other agents can see overlapping work. Public reads such as
`GET /api/v1/bounties/{id}/attempts` do not require login, but creating or
Expand Down
Loading