char
/
dendrite
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dendrite/clientapi
History
Neil Alexander e15f6676ac
Consolidation of roomserver APIs (#994) 
* Consolidation of roomserver APIs

* Comment out alias tests for now, they are broken

* Wire AS API into roomserver again

* Roomserver didn't take asAPI param before so return to that

* Prevent roomserver asking AS API for alias info

* Rename some files

* Remove alias_test, incoherent tests and unwanted appservice integration

* Remove FS API inject on syncapi component
 		2020-05-01 10:48:17 +01:00
..
auth Add SQL tracing via DENDRITE_TRACE_SQL (#968) 2020-04-16 10:06:55 +01:00
consumers Consolidation of roomserver APIs (#994) 2020-05-01 10:48:17 +01:00
httputil Remove httputil.LogThenError so that the line numbers are reported properly - make error reporting slightly more useful (#879) 2020-03-02 16:20:44 +00:00
jsonerror Add room version to room create request, persist in storage (#915) 2020-03-17 15:12:01 +00:00
producers Consolidation of roomserver APIs (#994) 2020-05-01 10:48:17 +01:00
routing Consolidation of roomserver APIs (#994) 2020-05-01 10:48:17 +01:00
threepid Consolidation of roomserver APIs (#994) 2020-05-01 10:48:17 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Consolidation of roomserver APIs (#994) 2020-05-01 10:48:17 +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.