jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
dendrite/clientapi
History
Till Faelligen 11b48749bf
Fix linting
2024-11-14 16:40:08 +01:00
..
api Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
auth Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
httputil Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
producers Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
routing Fix linting 2024-11-14 16:40:08 +01:00
threepid Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
userutil Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
admin_test.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
clientapi.go Update the license headers to mention the commercial license 2024-10-18 16:14:08 +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.