Skip to content
This repository has been archived by the owner on Aug 10, 2020. It is now read-only.

Latest commit

 

History

History
463 lines (459 loc) · 14.4 KB

STATUS.md

File metadata and controls

463 lines (459 loc) · 14.4 KB

Ruma Status

The following chart shows the status of support for the endpoints in the client-server API specification. If you're interested in working on an API, take a look at the corresponding tracking issue and leave a comment indicating your interest!

Legend:

✅ Supported 🚧 Partially supported 🚫 Not supported

Status Issue API endpoint
Versions
GET /versions
Login
POST /login
POST /tokenrefresh
POST /logout
Account registration and management
POST /register
🚫 #80 POST /account/password/email/requestToken
#81 POST /account/deactivate
POST /account/password
🚫 #82 POST /register/email/requestToken
Adding account administrative contact information
🚫 #4 POST /account/3pid
🚫 #5 GET /account/3pid
🚫 #83 POST /account/3pid/email/requestToken
Filtering
#6 GET /user/:user_id/filter/:filter_id
#7 POST /user/:user_id/filter
Syncing events
🚧 #8 GET /sync
Getting events for a room
#9 GET /rooms/:room_id/state
#10 GET /rooms/:room_id/members
🚫 #11 GET /rooms/:room_id/state/:event_type/:state_key
🚫 #12 GET /rooms/:room_id/state/:event_type
🚫 #13 GET /rooms/:room_id/messages
Sending events to a room
🚧 #14 PUT /rooms/:room_id/state/:event_type
🚧 #15 PUT /rooms/:room_id/state/:event_type/:state_key
🚧 #16 PUT /rooms/:room_id/send/:event_type/:transaction_id
Redactions
🚫 #17 PUT /rooms/:room_id/redact/:event_id/:transaction_id
Room creation
🚧 #18 POST /createRoom
Room aliases
#19 PUT /directory/room/:room_alias
#20 DELETE /directory/room/:room_alias
#21 GET /directory/room/:room_alias
Joining rooms
#22 POST /rooms/:room_id/invite
#23 POST /join/:room_id_or_alias
#24 POST /rooms/:room_id/join
#25 POST /rooms/:room_id/kick
🚫 #26 POST /rooms/:room_id/unban
🚫 #27 POST /rooms/:room_id/ban
Leaving rooms
🚫 #28 POST /rooms/:room_id/forget
🚫 #29 POST /rooms/:room_id/leave
Listing rooms
🚫 #30 GET /publicRooms
Profiles
#31 PUT /profile/:user_id/displayname
#32 GET /profile/:user_id/displayname
#33 PUT /profile/:user_id/avatar_url
#34 GET /profile/:user_id/avatar_url
#35 GET /profile/:user_id
Voice over IP
🚫 #36 GET /voip/turnServer
Typing notifications
🚫 #37 PUT /rooms/:room_id/typing/:user_id
Receipts
🚫 #38 POST /rooms/:room_id/receipt/:receipt_type/:event_id
Presence
🚧 #39 PUT /presence/:user_id/status
🚧 #40 GET /presence/:user_id/status
🚧 #41 POST /presence/list/:user_id
🚧 #42 GET /presence/list/:user_id
Content repository
🚫 #43 GET /download/:server_name/:media_id
🚫 #44 POST /upload
🚫 #45 GET /thumbnail/:server_name/:media_id
Push notifications
#46 POST /pushers/set
#47 GET /pushers
Push notification rules
🚫 #48 PUT /pushrules/:scope/:kind/:rule_id/enabled
🚫 #49 GET /pushrules/:scope/:kind/:rule_id/enabled
🚫 #50 PUT /pushrules/:scope/:kind/:rule_id
🚫 #51 DELETE /pushrules/:scope/:kind/:rule_id
🚫 #52 GET /pushrules/:scope/:kind/:rule_id
🚫 #53 GET /pushrules
🚫 #54 PUT /pushrules/:scope/:kind/:rule_id/actions
🚫 #55 GET /pushrules/:scope/:kind/:rule_id/actions
Third party invites
🚫 #56 POST /rooms/:room_id/invite
Server side search
🚫 #57 POST /search
Room previews
🚫 #58 GET /events
Room tagging
#59 PUT /user/:user_id/rooms/:room_id/tags/:tag
#60 DELETE /user/:user_id/rooms/:room_id/tags/:tag
#61 GET /user/:user_id/rooms/:room_id/tags
Client config
#62 PUT /user/:user_id/rooms/:room_id/account_data/:type
#63 PUT /user/:user_id/account_data/:type
Server administration
🚫 #64 GET /admin/whois/:user_id
Event context
🚫 #65 GET /rooms/:room_id/context/:event_id