docs: add missing public API endpoints to agent-guide.md (Bounty #426)#442
Merged
ramimbo merged 1 commit intoMay 26, 2026
Merged
Conversation
Add GET /api/v1/bounties/summary and GET /api/v1/ledger/{sequence}
to the Public API list and examples section. Both endpoints exist in
the live API (bounty_api.py and main.py) but were not documented,
making them undiscoverable by agents and contributors.
Bounty ramimbo#426
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation for public HTTP API endpoints expanded to include ChangesPublic API Documentation
Possibly related PRs
🚥 Pre-merge checks | ✅ 5 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
aunysillyme
reviewed
May 26, 2026
aunysillyme
left a comment
There was a problem hiding this comment.
Reviewed PR #442 at head e49f0d7f37265434eca6d01353061fe644e433c6 for Bounty #426.
Evidence:
- Inspected the PR files API and patch: the change is limited to
docs/agent-guide.mdwith 17 added documentation lines. - Verified the documented
GET /api/v1/bounties/summaryroute exists inapp/bounty_api.pyand accepts optionalstatusandqquery parameters before returningbounty_list_summary(...). - Verified the documented
GET /api/v1/ledger/{sequence}route exists inapp/main.py, validates the sequence withpositive_ledger_sequence(...), returnsledger_entry_to_dict(...), and 404s when the entry is missing. - Checked the added examples are public-read examples only and do not imply payout, price, bridge, off-ramp, or acceptance guarantees.
- GitHub reports the quality/readiness/docs/image check and CodeRabbit status green; PR metadata reports
MERGEABLE.
No blockers from my pass.
This was referenced May 26, 2026
Closed
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
Add two public API endpoints that exist in the live codebase but were missing from the agent guide documentation:
GET /api/v1/bounties/summary— lightweight counts-only bounty summary with optionalstatusandqfilters (implemented inapp/bounty_api.py)GET /api/v1/ledger/{sequence}— single ledger entry lookup by sequence number (implemented inapp/main.py)Evidence
GET /api/v1/bounties/summaryis registered atapp/bounty_api.pyline with@app.get("/api/v1/bounties/summary"), accepts optionalstatusandqquery params, and callsbounty_list_summary()GET /api/v1/ledger/{sequence}is registered atapp/main.pywith@app.get("/api/v1/ledger/{sequence}"), usespositive_ledger_sequence()validation, and returns a single ledger entry dict vialedger_entry_to_dict()Scope
docs/agent-guide.mdBounty #426
Summary by CodeRabbit