element-hq / element-hq/synapse

Document which Admin APIs can be routed to workers

Open
#9,629 0 comments 0 reactions 0 assignees View on GitHub
A-Admin-API A-Docs A-Workers T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#9629](https://github.com/matrix-org/synapse/issues/9629).

---

The [worker documentation](https://github.com/matrix-org/synapse/blob/dd5e5dc1d6c88a3532d25f18cfc312d8bc813473/docs/workers.md) currently only mentions placing the media Admin APIs on a worker other than the main process. It seems like other Admin APIs could also be moved off as well though, especially the read-only calls.

`GET /_synapse/admin/v1/rooms/` is one such example:

https://github.com/matrix-org/synapse/blob/ad8589d39254559b3eb4f38c528f8fc827dc4763/synapse/rest/admin/rooms.py#L285-L310

This becomes more important as more bots and processes are built on top of these APIs, and end up calling them frequently.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.