kgess-mirror/element-synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-01-16 23:00:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18

Merge 6334e78504 into 5a3362c012

Browse source
This commit is contained in:
Andrew Ferrazzutti 2026-01-09 16:37:04 +00:00 • committed by GitHub
commit 4a51561b8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/19307.doc Normal file
View file

@ -0,0 +1 @@
In the Admin API documentation, always express path parameters as `/<param>` instead of as `/$param`.

12
docs/admin_api/user_admin_api.md
View file

@ -599,7 +599,7 @@ Fetches the number of invites sent by the provided user ID across all rooms
after the given timestamp.
```
GET /_synapse/admin/v1/users/$user_id/sent_invite_count
GET /_synapse/admin/v1/users/<user_id>/sent_invite_count
```
**Parameters**
@ -633,7 +633,7 @@ Fetches the number of rooms that the user joined after the given timestamp, even
if they have subsequently left/been banned from those rooms.
```
GET /_synapse/admin/v1/users/$<user_id/cumulative_joined_room_count
GET /_synapse/admin/v1/users/<user_id>/cumulative_joined_room_count
```
**Parameters**
@ -1438,7 +1438,7 @@ The request and response format is the same as the
The API is:
```
GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id
GET /_synapse/admin/v1/auth_providers/<provider>/users/<external_id>
```
When a user matched the given ID for the given provider, an HTTP code `200` with a response body like the following is returned:
@ -1477,7 +1477,7 @@ _Added in Synapse 1.68.0._
The API is:
```
GET /_synapse/admin/v1/threepid/$medium/users/$address
GET /_synapse/admin/v1/threepid/<medium>/users/<address>
```
When a user matched the given address for the given medium, an HTTP code `200` with a response body like the following is returned:
@ -1521,7 +1521,7 @@ is provided to override the default and allow the admin to issue the redactions
The API is
```
POST /_synapse/admin/v1/user/$user_id/redact
POST /_synapse/admin/v1/user/<user_id>/redact
{
"rooms": ["!roomid1", "!roomid2"]
@ -1570,7 +1570,7 @@ or until Synapse is restarted (whichever happens first).
The API is:
```
GET /_synapse/admin/v1/user/redact_status/$redact_id
GET /_synapse/admin/v1/user/redact_status/<redact_id>
```
A response body like the following is returned: