dendrite/clientapi
Neil Alexander c6ea2c9ff2
Add /_dendrite/admin/evacuateRoom/{roomID} (#2401)
* Add new endpoint to allow admins to evacuate the local server from the room

* Guard endpoint

* Use right prefix

* Auth API

* More useful return error rather than a panic

* More useful return value again

* Update the path

* Try using inputer instead

* oh provide the config

* Try that again

* Return affected user IDs

* Don't create so many forward extremities

* Add missing `Path` to name

Co-authored-by: Till <2353100+S7evinK@users.noreply.github.com>
2022-04-28 16:02:30 +01:00
..
api Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
auth User directory for nearby Pinecone peers (P2P demo) (#2311) 2022-03-28 16:25:26 +01:00
httputil Support for m.login.token (#2014) 2022-02-10 10:27:26 +00:00
jsonerror Add canonical alias support (#2236) 2022-03-07 10:37:04 +01:00
producers Add possibility to ignore users (#2329) 2022-04-07 15:08:19 +01:00
routing Add /_dendrite/admin/evacuateRoom/{roomID} (#2401) 2022-04-28 16:02:30 +01:00
threepid Refactor appservice & client API to use userapi internal (#2290) 2022-03-24 22:45:44 +01:00
userutil - Removed double imports (#1989) 2021-09-08 17:31:03 +01:00
clientapi.go Add /_dendrite/admin/evacuateRoom/{roomID} (#2401) 2022-04-28 16:02:30 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

This component roughly corresponds to "Client Room Send" and "Client Sync" on the WIRING diagram. This component produces multiple binaries.

Internals

  • HTTP routing is done using gorilla/mux and the routing paths are in the routing package.

Writers

  • Each HTTP "write operation" (/createRoom, /rooms/$room_id/send/$type, etc) is contained entirely to a single file in the writers package.
  • This file contains the request and response struct definitions, as well as a Validate() bool function to validate incoming requests.
  • The entry point for each write operation is a stand-alone function as this makes testing easier. All dependencies should be injected into this function, including server keys/name, etc.