Changeset 5143ccf in Klonkt for FEDERATION.md

Timestamp:

07/20/2026 11:12:43 PM (7 weeks ago)

Author:

Robin <roboburr@…>

Branches:

main

Children:

30871c1

Parents:

7922694

git-author:

Robin <roboburr@…> (07/20/2026 11:12:41 PM)

git-committer:

Robin <roboburr@…> (07/20/2026 11:12:43 PM)

Message:

Docs: the Shaer to Klonkt C2S API

Documents the contract the Shaer apps use to drive a Klonkt account:
discovery (WebFinger -> actor -> endpoints), OAuth (register, PKCE
authorize, token, bearer), the owner reads (actor, outbox, inbox,
enriched followers/following with name + avatar), the outbox writes
(Create/Like/Announce/Follow/Undo, the to/cc visibility mapping,
direct notes, attachments, shaer:helpRequest, the not_public
hardening), uploadMedia, the shaer: vocabulary (FEP-633c) and an error
reference. Linked from FEDERATION.md.

Changed files:
docs/shaer-c2s-api.md

• the full C2S reference

New file:
docs/shaer-c2s-api.md

FEDERATION.md

• link to the client API doc under Additional documentation

-robo
Co-Authored-By: Claude Opus 4.8 <noreply@…>

File:

• FEDERATION.md (modified) (1 diff)

FEDERATION.md

@@ -153 +153 @@
 ## Additional documentation
 
+- Client-to-Server API for apps (the Shaer contract): `docs/shaer-c2s-api.md`.
 - Source code: `src/services/ActivityPubService.js` (core AP logic),
   `src/routes/activitypub.js` (S2S, WebFinger, NodeInfo),