mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/element-hq/dendrite.git synced 2025-09-13 21:02:25 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
dendrite/clientapi
History
Quentin Gliech 891950f7b6
Replace references to the repository
2024-10-17 17:34:12 +02:00
..
api Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
auth Rename the go package 2024-10-17 17:33:45 +02:00
httputil Fixup missed license headers 2024-10-17 17:21:25 +02:00
producers Rename the go package 2024-10-17 17:33:45 +02:00
routing Rename the go package 2024-10-17 17:33:45 +02:00
threepid Rename the go package 2024-10-17 17:33:45 +02:00
userutil Rename the go package 2024-10-17 17:33:45 +02:00
admin_test.go Rename the go package 2024-10-17 17:33:45 +02:00
clientapi.go Rename the go package 2024-10-17 17:33:45 +02:00
clientapi_test.go Rename the go package 2024-10-17 17:33:45 +02:00
README.md Replace references to the repository 2024-10-17 17:34:12 +02: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.