Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Matrix
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Operate
Environments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TeDomum
Matrix
Commits
e2c16edc
Commit
e2c16edc
authored
4 years ago
by
Jason Robinson
Browse files
Options
Downloads
Patches
Plain Diff
Add changelog and admin API docs
Signed-off-by:
Jason Robinson
<
jasonr@matrix.org
>
parent
2eb421b6
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changelog.d/9062.feature
+1
-0
1 addition, 0 deletions
changelog.d/9062.feature
docs/admin_api/rooms.md
+53
-0
53 additions, 0 deletions
docs/admin_api/rooms.md
with
54 additions
and
0 deletions
changelog.d/9062.feature
0 → 100644
+
1
−
0
View file @
e2c16edc
Add
admin
AP
I
for getting and deleting forward extremities for a room.
This diff is collapsed.
Click to expand it.
docs/admin_api/rooms.md
+
53
−
0
View file @
e2c16edc
...
...
@@ -9,6 +9,7 @@
*
[
Response
](
#response
)
*
[
Undoing room shutdowns
](
#undoing-room-shutdowns
)
-
[
Make Room Admin API
](
#make-room-admin-api
)
-
[
Forward Extremities Admin API
](
#forward-extremities-admin-api
)
# List Room API
...
...
@@ -511,3 +512,55 @@ optionally be specified, e.g.:
"user_id": "@foo:example.com"
}
```
# Forward Extremities Admin API
Enables querying and deleting forward extremities from rooms. When a lot of forward
extremities accumulate in a room, performance can become degraded.
When using this API endpoint to delete any extra forward extremities for a room,
the server does not need to be restarted as the relevant caches will be cleared
in the API call.
## Check for forward extremities
To check the status of forward extremities for a room:
```
GET /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
```
A response as follows will be returned:
```
json
{
"count"
:
1
,
"results"
:
[
{
"event_id"
:
"$M5SP266vsnxctfwFgFLNceaCo3ujhRtg_NiiHabcdfgh"
,
"state_group"
:
439
}
]
}
```
## Deleting forward extremities
In the event a room has lots of forward extremities, the extra can be
deleted as follows:
```
DELETE /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
```
A response as follows will be returned, indicating the amount of forward extremities
that were deleted.
```
json
{
"deleted"
:
1
}
```
The cache
`get_latest_event_ids_in_room`
will be invalidated, if any forward extremities
were deleted.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment