docs: update activity API example fields#412
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdates API docs for GET /api/v1/activity to broaden the ChangesActivity API Bounty Metadata
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
e82c336 to
df18b03
Compare
6 tasks
ramimbo
pushed a commit
that referenced
this pull request
May 26, 2026
Public MCP docs list get_ledger_entry and get_wallet, but the API examples did not show direct JSON-RPC calls or the wrapped result.content[0].text response shapes. This adds two focused examples and pins the documented fields with a docs regression test. Constraint: Bounty #411 asks for accurate public API or MCP examples backed by app code or live endpoints Rejected: Update activity API examples | already covered by open PR #412 Confidence: high Scope-risk: narrow Directive: Keep MCP examples synchronized with app/mcp_tools.py and serializer response wrappers Tested: .venv/bin/python -m pytest Tested: .venv/bin/python -m ruff format --check . Tested: .venv/bin/python -m ruff check . Tested: .venv/bin/python -m mypy app Tested: .venv/bin/python scripts/docs_smoke.py Tested: git diff --check Not-tested: live public MCP and REST endpoint calls from this network timed out
5 tasks
This was referenced May 26, 2026
This was referenced May 26, 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.
Bounty #411
Summary
/api/v1/activityexample so contributor rollups include latest bounty metadata.bounty_repo,bounty_issue_url, andbounty_urlfields that the current serializer and live API return.Evidence
Compared
docs/api-examples.mdwith current code inapp/serializers.pyand the live unauthenticated endpoint:Observed live
recent[0]includesbounty_repo,bounty_issue_url, andbounty_urlalongsidebounty_idandbounty_issue_number. The old docs example only showedbounty_idandbounty_issue_number.Expected PR size: small docs/test update.
Tests
/Users/daneul.kim/Documents/New\ project/bounty-work/mergework/.venv/bin/python scripts/docs_smoke.py-> docs smoke ok/Users/daneul.kim/Documents/New\ project/bounty-work/mergework/.venv/bin/python -m pytest tests/test_docs_public_urls.py -q-> 17 passed/Users/daneul.kim/Documents/New\ project/bounty-work/mergework/.venv/bin/python -m ruff check docs/api-examples.md tests/test_docs_public_urls.py-> passedgit diff --check-> cleanNo private keys, seed material, secrets, private vulnerability details, deployment credentials, price claims, investment claims, liquidity claims, bridge promises, exchange claims, or fabricated payout claims are included.
Summary by CodeRabbit