aboutsummaryrefslogtreecommitdiffstats
path: root/packages/meshbay-hub/src/meshbay_hub/api/federation.py
diff options
context:
space:
mode:
authorChristophe Besson <cbesson@gmail.com>2026-10-05 10:36:18 +0200
committerChristophe Besson <cbesson@gmail.com>2026-10-05 10:36:18 +0200
commitb8671635cd891068afee81fde05bed880124ec85 (patch)
tree8e5ba99cd13558f88d2a31eb9d0f4d937128d255 /packages/meshbay-hub/src/meshbay_hub/api/federation.py
parent41d015137d6d9c097e462cd0662e855c3253d001 (diff)
downloadmeshbay-b8671635cd891068afee81fde05bed880124ec85.tar.gz
docs: generate an HTTP API listing for the hub and the node control API
docs/MESHBAY_HTTP_API.md lists every route of the hub (by domain, with the authentication each requires) and of the node's loopback control API. It is written by docs/generate_http_api.py from the routes and their docstrings; test_http_api_doc.py fails when the file drifts from the code or when a route has no docstring, so a new route must say what it does. 79 routes had no docstring and get a one-line description; a few whose first line did not describe the route get a summary line. The login page's developer docs gain an API link next to Design and Protocol, in every language. README, MESHBAY_DESIGN.md (§0.1, §6.7, §7) and CLAUDE.md point to the listing; README also points to examples/. The examples scripts with a shebang become executable. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'packages/meshbay-hub/src/meshbay_hub/api/federation.py')
-rw-r--r--packages/meshbay-hub/src/meshbay_hub/api/federation.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/packages/meshbay-hub/src/meshbay_hub/api/federation.py b/packages/meshbay-hub/src/meshbay_hub/api/federation.py
index 755639e..e737a1c 100644
--- a/packages/meshbay-hub/src/meshbay_hub/api/federation.py
+++ b/packages/meshbay-hub/src/meshbay_hub/api/federation.py
@@ -190,6 +190,7 @@ async def export_directory(
db: AsyncSession = Depends(get_db),
authorization: str = Header(...),
):
+ """This hub's public groups, for a peer hub presenting an MHP token."""
try:
await _verify_mhp_token(authorization.removeprefix("Bearer "), db)
except Exception as e:
@@ -232,6 +233,7 @@ async def receive_directory(
authorization: str = Header(...),
db: AsyncSession = Depends(get_db),
):
+ """A peer hub's public groups, pushed with a single-use MHP token."""
try:
payload = await _verify_mhp_token(
authorization.removeprefix("Bearer "), db, single_use=True)