jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
f956a8c1d9
dendrite/clientapi
History
Till f956a8c1d9
Docs restructure (#2953) 
Needs to be merged into `gh-pages` later on.
2023-05-30 10:02:53 +02:00
..
api
auth Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
httputil Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
producers
routing Docs restructure (#2953) 2023-05-30 10:02:53 +02:00
threepid Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
userutil
admin_test.go Docs restructure (#2953) 2023-05-30 10:02:53 +02:00
clientapi_test.go Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
clientapi.go
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.