butter/dendrite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
dendrite/clientapi
History
S7evinK 8a4b90b7dd
Update golangci-lint (#1978) 
* Update golangci-lint

* Use unconditional strings.TrimSuffix

* Add error checks

Signed-off-by: Till Faelligen <tfaelligen@gmail.com>

* Disable lint typecheck

* Fix ineffectual error assignment (#1976)

Was working on another PR and noticed that golangci-lint was failing
locally on `ineffassign`

Signed-off-by: Devon Mizelle <dev@devon.so>

* Revert "Disable lint typecheck"

This reverts commit 3c76f219d3cb43e4ee9a9c319abd0b8879972cfc.

Co-authored-by: Devon Mizelle <dev@devon.so>
2021-08-17 10:39:09 +01:00
..
api Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
auth Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
httputil reject invalid UTF-8 (#1472) 2020-10-09 09:15:51 +01:00
jsonerror Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
producers Rehuffle where things are in the internal package (#1122) 2020-06-12 14:55:57 +01:00
routing Update golangci-lint (#1978) 2021-08-17 10:39:09 +01:00
threepid Top-level setup package (#1605) 2020-12-02 17:41:00 +00:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Implement /_synapse/admin/v1/register (#1911) 2021-07-09 16:52:31 +01: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.