swarm-matrix-client: document the room calls; test the whoami refusal
This commit is contained in:
parent
b17da10cfc
commit
ff256d0b1c
4 changed files with 58 additions and 10 deletions
|
|
@ -1,9 +1,13 @@
|
|||
//! The appservice calls against the swarm's homeserver: register, log in, ask
|
||||
//! a token who it is, and the room calls `swarm-controller`'s admin-room
|
||||
//! commands need (resolve an alias, list members, check an account exists,
|
||||
//! send a message). Also the password login and logout `swarm-controller` runs
|
||||
//! for an operator-linked account on any homeserver. Shared by `swarm-matrix-ctl` and `swarm-controller`;
|
||||
//! see the README for why both mint through the same device id.
|
||||
//! The calls against a Matrix homeserver's client-server API shared by the
|
||||
//! swarm and the hive: the appservice calls (register, log in, ask a token who
|
||||
//! it is), the room calls `swarm-controller`'s admin-room commands and
|
||||
//! `hive-c0re`'s Space and chat-room provisioning need (resolve an alias, list
|
||||
//! members and joined rooms, read and set room state, create a room, invite, send
|
||||
//! a message, check an account exists), and the password login and logout
|
||||
//! `swarm-controller` runs for an operator-linked account on any homeserver.
|
||||
//! Shared by `swarm-matrix-ctl`, `swarm-controller`, `hive-c0re` and
|
||||
//! `hive-matrix-mcp`. See the README for why both appservice mints go through
|
||||
//! the same device id.
|
||||
//!
|
||||
//! 🩸 **Every error in this module is built from the response's `status` and
|
||||
//! its `errcode`, never its body.** A successful `/register` or `/login` body
|
||||
|
|
|
|||
Loading…
Reference in a new issue