Skip to content

Bounty #427: Add docs endpoint shortcuts #559

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
Baijack-star wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

Bounty #427: Add docs endpoint shortcuts #559

Show file tree
Hide file tree
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
8 changes: 8 additions & 0 deletions app/templates/docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ <h2>Project docs</h2>
<ul class="doc-list">
<li><a href="/api/v1/status">API status</a></li>
<li><a href="/api/docs">OpenAPI docs</a></li>
<li><a href="/openapi.json">OpenAPI JSON schema</a></li>
<li><a href="/api/v1/bounties">Bounty API</a></li>
<li><a href="/activity">Activity dashboard</a></li>
<li><a href="/api/v1/activity">Activity API</a></li>
Expand All @@ -29,6 +30,13 @@ <h2>Project docs</h2>
<li><a href="https://github.com/ramimbo/mergework/blob/main/docs/api-examples.md">Public API examples</a></li>
<li><a href="https://github.com/ramimbo/mergework/blob/main/docs/ledger.md">Ledger details</a></li>
</ul>
<h2>Machine-readable shortcuts</h2>
<ul class="doc-list">
<li><a href="/api/v1/bounties?status=open&amp;sort=available">Open bounties by available MRWK</a></li>
<li><a href="/api/v1/bounties/summary?status=open">Open bounty summary</a></li>
<li><a href="/api/v1/activity?limit=20">Latest accepted-work activity JSON</a></li>
<li><a href="https://mcp.mrwk.ltclab.site/mcp">MCP JSON-RPC endpoint</a></li>
</ul>
<h2>Payout access</h2>
<p>MRWK balances can live on native <code>mrwk1</code> wallet addresses. A wallet signs transfer, GitHub-link, and claim payloads with its private key; the server verifies signatures and records accepted movements in the explorer.</p>
</section>
Expand Down
5 changes: 5 additions & 0 deletions tests/test_api_mcp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1543,8 +1543,13 @@ def test_docs_page_lists_live_ltclab_urls(sqlite_url: str) -> None:
assert "docs/paid-bounties.md" in docs
assert "docs/api-examples.md" in docs
assert "OpenAPI docs" in docs
assert 'href="/openapi.json">OpenAPI JSON schema</a>' in docs
assert 'href="/activity"' in docs
assert 'href="/api/v1/activity"' in docs
assert 'href="/api/v1/bounties?status=open&amp;sort=available"' in docs
assert 'href="/api/v1/bounties/summary?status=open"' in docs
assert 'href="/api/v1/activity?limit=20"' in docs
assert 'href="https://mcp.mrwk.ltclab.site/mcp"' in docs
assert "SwaggerUIBundle" in api_docs


Expand Down
Loading