dendrite/clientapi
2024-01-09 20:05:45 +01:00
..
api
auth Appservice Login (2nd attempt) (#3078) 2023-11-24 22:34:13 +01:00
httputil
producers
routing Return M_INVALID_PARAM instead of M_BAD_JSON when setting aliases (#3297) 2024-01-09 20:05:45 +01:00
threepid
userutil
admin_test.go Use IsBlacklistedOrBackingOff to determine if we should try to fetch devices (#3254) 2023-11-09 08:43:27 +01:00
clientapi.go
clientapi_test.go Use IsBlacklistedOrBackingOff to determine if we should try to fetch devices (#3254) 2023-11-09 08:43:27 +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.