matrix-org / matrix-org/matrix-spec

Spec appropriate admin APIs

Open
#328 6 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server feature
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Synapse has a number of admin APIs, some of which are useful outside of synapse. The whole lot needs to be gone through to figure out what is useful and what isn't.

This is to support things like https://github.com/matrix-org/matrix-python-sdk/pull/247 which wish to actually use these APIs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying Synapse's admin APIs and comparing them with the use case in matrix-python-sdk pull request 247. Done means deciding which APIs are useful outside Synapse and documenting the appropriate set in the Matrix specification.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.