MirrorHub/dendrite
0
0
Fork 0
mirror of https://github.com/matrix-org/dendrite synced 2024-09-09 04:31:38 +02:00
Code Issues Releases Wiki Activity
dendrite/clientapi
History
kegsay 3691423626
Move GMSL client types to Dendrite (#3045) 
GMSL is intended for Federation only. Sister PR to
https://github.com/matrix-org/gomatrixserverlib/pull/357
2023-04-04 17:16:53 +00:00
..
api Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
auth Add tests for /turnServer, /capabilities and /3pid/ (#3038) 2023-04-03 21:42:46 +02:00
httputil Do not use ioutil as it is deprecated (#2625) 2022-08-05 10:26:59 +01:00
jsonerror Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
producers Send-to-device consumer/producer tweaks (#2713) 2022-09-13 09:35:45 +02:00
routing Move GMSL client types to Dendrite (#3045) 2023-04-04 17:16:53 +00:00
threepid Add tests for /turnServer, /capabilities and /3pid/ (#3038) 2023-04-03 21:42:46 +02:00
userutil Fix registration for virtual hosting 2022-11-18 13:24:02 +00:00
admin_test.go Add user profile tests, refactor user API methods (#3030) 2023-04-03 20:19:26 +02:00
clientapi.go Remove BaseDendrite (#3023) 2023-03-22 09:21:32 +01:00
clientapi_test.go Add tests for /turnServer, /capabilities and /3pid/ (#3038) 2023-04-03 21:42:46 +02:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +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.