dendrite/clientapi
Till b367cfeddf
Implement /thirdparty endpoints (#2831)
Implements the following endpoints 
```
GET /_matrix/client/v3/thirdparty/protocols
GET /_matrix/client/v3/thirdparty/protocols/{protocol}
GET /_matrix/client/v3/thirdparty/location
GET /_matrix/client/v3/thirdparty/location/{protocol}
GET /_matrix/client/v3/thirdparty/user
GET /_matrix/client/v3/thirdparty/user/{protocol}
```
2022-11-02 10:17:53 +00:00
..
api
auth Initial support for multiple server names (#2829) 2022-10-26 12:59:19 +01:00
httputil
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 Implement /thirdparty endpoints (#2831) 2022-11-02 10:17:53 +00:00
threepid Initial support for multiple server names (#2829) 2022-10-26 12:59:19 +01:00
userutil Initial support for multiple server names (#2829) 2022-10-26 12:59:19 +01:00
clientapi.go
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.