dendrite/clientapi
2023-05-01 21:28:10 -06:00
..
api
auth
httputil
jsonerror Add key backup tests (#3071) 2023-04-28 17:49:38 +02:00
producers
routing Add key backup tests (#3071) 2023-04-28 17:49:38 +02:00
threepid Remove gmsl.HeaderedEvent (#3068) 2023-04-27 12:54:20 +01:00
userutil
admin_test.go Pass federation API to roomserver in PurgeRoom tests 2023-05-01 21:28:10 -06:00
clientapi_test.go Add key backup tests (#3071) 2023-04-28 17:49:38 +02:00
clientapi.go Move fedclient interface over to gmsl (#3061) 2023-04-24 16:23:25 +00: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.