1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-12 23:01:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
4c15c73b3a
dendrite/clientapi
History
kegsay 85704eff20
Clean up interface definitions (#2427) 
* tidy up interfaces

* remove unused GetCreatorIDForAlias

* Add RoomserverUserAPI interface

* Define more interfaces

* Use AppServiceInternalAPI for consistent naming

* clean up federationapi constructor a bit

* Fix monolith in -http mode
2022-05-06 12:39:26 +01:00
..
api Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
auth Define component interfaces based on consumers (1/2) (#2423) 2022-05-05 13:17:38 +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 Define component interfaces based on consumers (1/2) (#2423) 2022-05-05 13:17:38 +01:00
routing Clean up interface definitions (#2427) 2022-05-06 12:39:26 +01:00
threepid Define component interfaces based on consumers (1/2) (#2423) 2022-05-05 13:17:38 +01:00
userutil - Removed double imports (#1989) 2021-09-08 17:31:03 +01:00
clientapi.go Clean up interface definitions (#2427) 2022-05-06 12:39:26 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

README.md

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.