jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9d9e854fe0
dendrite/clientapi
History
Kegsay 9d9e854fe0
Add Queryer and Inputer and factor out more RSAPI stuff (#1382) 
* Add Queryer and use embedded structs

* Add Inputer and factor out more RS API stuff

This neatly splits up the RS API based on the functionality it provides,
whilst providing a useful place for code sharing via the `helpers` package.
2020-09-02 17:13:15 +01:00
..
api Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
auth Configuration format v1 (#1230) 2020-08-10 14:18:04 +01:00
httputil
jsonerror Return remote errors from FS.PerformJoin (#1164) 2020-06-25 15:04:48 +01:00
producers
routing Add Queryer and Inputer and factor out more RSAPI stuff (#1382) 2020-09-02 17:13:15 +01:00
threepid Add Queryer and Inputer and factor out more RSAPI stuff (#1382) 2020-09-02 17:13:15 +01:00
userutil
clientapi.go Remove device DB from clientapi (#1352) 2020-08-27 18:53:40 +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.