jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
f4c676ccdd
dendrite/clientapi
History
Kegsay 097cdf879c
s/Base64String/Base64Bytes/g (#1093) 
* s/Base64String/Base64Bytes/g

Requires https://github.com/matrix-org/gomatrixserverlib/pull/203 to land first

* update gmsl
2020-06-04 11:50:57 +01:00
..
auth s/Base64String/Base64Bytes/g (#1093) 2020-06-04 11:50:57 +01:00
consumers Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +01:00
httputil
jsonerror
producers Send-to-device support (#1072) 2020-06-01 17:50:19 +01:00
routing Enable room version 6 (#1087) 2020-06-04 10:53:39 +01:00
threepid s/Base64String/Base64Bytes/g (#1093) 2020-06-04 11:50:57 +01:00
userutil
clientapi.go Separate muxes for public and internal APIs (#1056) 2020-05-22 11:43:17 +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.