mirror/dendrite
3
0
Fork 0
mirror of https://github.com/element-hq/dendrite.git synced 2025-07-01 00:06:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dendrite/clientapi
History
Exact
Till 518697fd87
Return correct error message when sending server notices (#3594) 
Fixes #3502

### Pull Request Checklist

<!-- Please read
https://matrix-org.github.io/dendrite/development/contributing before
submitting your pull request -->

* [x] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off
below](https://element-hq.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately

Signed-off-by: Till Faelligen <2353100+S7evinK@users.noreply.github.com>
2025-06-05 21:07:37 +02: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 Return correct error message when sending server notices (#3594) 2025-06-05 21:07:37 +02: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.go Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
clientapi_test.go Rename the go package 2024-10-17 17:33:45 +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.