1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-21 19:21:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
79d4a0e399
dendrite/clientapi
History
Sam Wedgwood 9582827493
de-MSC-ifying space summaries (MSC2946) (#3134) 
- This PR moves and refactors the
[code](https://github.com/matrix-org/dendrite/blob/main/setup/mscs/msc2946/msc2946.go)
for
[MSC2946](https://github.com/matrix-org/matrix-spec-proposals/pull/2946)
('Space Summaries') to integrate it into the rest of the codebase.
- Means space summaries are no longer hidden behind an MSC flag
- Solves #3096

Signed-off-by: Sam Wedgwood <sam@wedgwood.dev>
2023-07-20 15:06:05 +01:00
..
api feat: admin APIs for token authenticated registration (#3101) 2023-06-22 16:37:21 +00:00
auth Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
httputil Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
producers refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
routing de-MSC-ifying space summaries (MSC2946) (#3134) 2023-07-20 15:06:05 +01:00
threepid Merge SenderID & Per Room User Key work (#3109) 2023-06-14 14:23:46 +00:00
userutil refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
admin_test.go de-MSC-ifying space summaries (MSC2946) (#3134) 2023-07-20 15:06:05 +01:00
clientapi_test.go de-MSC-ifying space summaries (MSC2946) (#3134) 2023-07-20 15:06:05 +01:00
clientapi.go Move fedclient interface over to gmsl (#3061) 2023-04-24 16:23:25 +00: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.