Document activity API response shape#253
Merged
Merged
Conversation
MolhamHamwi
reviewed
May 25, 2026
Contributor
MolhamHamwi
left a comment
There was a problem hiding this comment.
No blockers found.
Evidence checked:
- Inspected the diff in
docs/api-examples.mdandtests/test_docs_public_urls.py; the documented/api/v1/activity?q=p3xillresponse shape matches the currentactivity_to_dict()implementation: top-leveltotals,query,contributors, andrecent, with contributor rollups and recent payment rows. - Cross-checked
app/main.pybehavior for query filtering, contributor sorting by accepted MRWK,recent[:100], and removal of internalamount_microunitsbefore returning the public response. - Queried the live public endpoint
https://api.mrwk.ltclab.site/api/v1/activity?q=p3xilland confirmed the documented example keys and sample values are consistent (accepted_awards: 2,accepted_mrwk: "115",ledger_sequence: 399,bounty_id: 37,bounty_issue_number: 219). - Ran local checks:
pytest tests/test_docs_public_urls.py -q(14 passed),ruff check docs/api-examples.md tests/test_docs_public_urls.py,ruff format --check tests/test_docs_public_urls.py. The Markdown file is not passed toruff format --checkbecause this Ruff version reports Markdown formatting as preview-only.
Thanhdn1984
approved these changes
May 25, 2026
Thanhdn1984
left a comment
There was a problem hiding this comment.
Review claim for #219 on PR #253:
- PR: #253
- Scope checked: docs/api-examples.md + tests/test_docs_public_urls.py changes for bounty #229 activity API example.
- Evidence checked against diff: documents
/api/v1/activity?q=..., responsetotals, contributor rollups,recentpayment rows, proof hash/url fields, bounty id/issue fields, and sort/cap guidance. - Local validation on PR head
c581bc7:python3 scripts/docs_smoke.py-> docs smoke ok;python3 -m pytest tests/test_docs_public_urls.py -q-> 14 passed;git diff --check origin/main...HEAD-> clean. - Result: approve. The example/test are docs-only, match the advertised public activity shape, and don't expose secrets, private keys, payout credentials, private vulnerability details, PayPal details, or MRWK price claims.
weilixiong
approved these changes
May 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/api/v1/activity?q=...filter and response shape in public API examplesapp/main.py::activity_to_dict()/api_activity()and the live unauthenticated endpointhttps://api.mrwk.ltclab.site/api/v1/activity?q=p3xillTest Plan
python3 scripts/docs_smoke.py/opt/hermes/.venv/bin/python -m pytest tests/test_docs_public_urls.py -qRefs #229
Bounty #229
/claim #229