jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
4705f5761e
dendrite/clientapi
History
kegsay 9957752a9d
Define component interfaces based on consumers (2/2) (#2425) 
* convert remaining interfaces

* Tidy up the userapi interfaces
2022-05-05 19:30:38 +01:00
..
api
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 Define component interfaces based on consumers (2/2) (#2425) 2022-05-05 19:30:38 +01:00
threepid Define component interfaces based on consumers (1/2) (#2423) 2022-05-05 13:17:38 +01:00
userutil
clientapi.go Define component interfaces based on consumers (2/2) (#2425) 2022-05-05 19:30:38 +01:00
README.md

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.