Skip to content

docs: add missing public API endpoints to agent-guide.md (Bounty #426)#442

Merged
ramimbo merged 1 commit into
ramimbo:mainfrom
jacksong2049-prog:docs/missing-api-endpoints-426
May 26, 2026
Merged

docs: add missing public API endpoints to agent-guide.md (Bounty #426)#442
ramimbo merged 1 commit into
ramimbo:mainfrom
jacksong2049-prog:docs/missing-api-endpoints-426

Conversation

@jacksong2049-prog
Copy link
Copy Markdown
Contributor

@jacksong2049-prog jacksong2049-prog commented May 26, 2026

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 optional status and q filters (implemented in app/bounty_api.py)
  • GET /api/v1/ledger/{sequence} — single ledger entry lookup by sequence number (implemented in app/main.py)

Evidence

  • GET /api/v1/bounties/summary is registered at app/bounty_api.py line with @app.get("/api/v1/bounties/summary"), accepts optional status and q query params, and calls bounty_list_summary()
  • GET /api/v1/ledger/{sequence} is registered at app/main.py with @app.get("/api/v1/ledger/{sequence}"), uses positive_ledger_sequence() validation, and returns a single ledger entry dict via ledger_entry_to_dict()
  • Both endpoints are public (no auth required) and return JSON responses

Scope

  • Only changes docs/agent-guide.md
  • Adds the two endpoints to the Public API list
  • Adds concise usage examples in the Public API Examples section
  • No behavioral changes to any code

Bounty #426

Summary by CodeRabbit

  • Documentation
    • Expanded documented public HTTP API endpoints with new bounty summary and ledger lookup capabilities.
    • Added examples for bounty summary queries and individual ledger entry retrieval.
    • Reorganized API endpoint listings for improved clarity.

Review Change Stack

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
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ba8e1a4b-5839-44cb-9218-908912f078b3

📥 Commits

Reviewing files that changed from the base of the PR and between 764e9ed and e49f0d7.

📒 Files selected for processing (1)
  • docs/agent-guide.md

📝 Walkthrough

Walkthrough

Documentation for public HTTP API endpoints expanded to include GET /api/v1/bounties/summary and GET /api/v1/ledger/{sequence}, with usage examples for bounty summary queries and single ledger entry lookups.

Changes

Public API Documentation

Layer / File(s) Summary
API endpoint list
docs/agent-guide.md
The "Public API" endpoint reference list now includes GET /api/v1/bounties/summary and GET /api/v1/ledger/{sequence}, with reordering of existing endpoints.
API usage examples
docs/agent-guide.md
Documentation examples added for calling GET /api/v1/bounties/summary with optional status and q query parameters, and for fetching a single ledger entry via GET /api/v1/ledger/{sequence}.

Possibly related PRs

  • ramimbo/mergework#311: Implements the /api/v1/bounties/summary endpoint that this PR documents, including status and q query parameter behavior.
  • ramimbo/mergework#387: Previous documentation update to docs/agent-guide.md covering overlapping bounty and ledger API endpoints.
🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Bounty Pr Focus ⚠️ Warning Claims only docs/agent-guide.md changed but adds 128 files (21226 insertions). Two documented endpoints do exist, but scope massively exceeds stated intent. Split into focused docs PR (+17 lines for two endpoints) and separate initial repo setup commit.
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Title clearly names the changed surface (missing public API endpoints) and directly matches the main changeset (documentation updates to agent-guide.md).
Description check ✅ Passed Description covers summary, evidence of endpoint implementations, scope, and bounty reference, though test evidence checklist section is not marked.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Mergework Public Artifact Hygiene ✅ Passed PR documents two existing API endpoints without fabricating investment, price, cash-out, payout, or security claims; MRWK references remain appropriate.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@aunysillyme aunysillyme left a comment

Choose a reason for hiding this comment

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

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.md with 17 added documentation lines.
  • Verified the documented GET /api/v1/bounties/summary route exists in app/bounty_api.py and accepts optional status and q query parameters before returning bounty_list_summary(...).
  • Verified the documented GET /api/v1/ledger/{sequence} route exists in app/main.py, validates the sequence with positive_ledger_sequence(...), returns ledger_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.

@ramimbo ramimbo merged commit 954a8aa into ramimbo:main May 26, 2026
2 checks passed
@ramimbo ramimbo added mrwk:accepted Maintainer accepted for payout mrwk:paid Ledger payment recorded labels May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mrwk:accepted Maintainer accepted for payout mrwk:paid Ledger payment recorded

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants