Skip to content

Add admin API for fetching room reports#18253

Closed
turt2live wants to merge 8 commits into
developfrom
travis/adminapi-report-room
Closed

Add admin API for fetching room reports#18253
turt2live wants to merge 8 commits into
developfrom
travis/adminapi-report-room

Conversation

@turt2live

@turt2live turt2live commented Mar 18, 2025

Copy link
Copy Markdown
Member

Very much a copy/paste of the event reporting API: https://element-hq.github.io/synapse/latest/admin_api/event_reports.html

Differences:

  • No sender or sender filtering - rooms don't have senders.
  • No get individual report detail API - there are other APIs for getting room details (which are the relevant parts of a report anyway).
  • No delete individual report API - just isn't needed at this stage. A future PR/contributor can add one.
  • No score - there isn't any.
  • No event_id - there isn't any.

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct
    (run the linters)

@turt2live turt2live requested a review from a team as a code owner March 18, 2025 21:37
@github-actions github-actions Bot deployed to PR Documentation Preview March 18, 2025 21:39 Active
@github-actions github-actions Bot deployed to PR Documentation Preview March 18, 2025 21:43 Active
@reivilibre

Copy link
Copy Markdown
Contributor

@turt2live the trial unit tests are failing FWIW

@turt2live

Copy link
Copy Markdown
Member Author

I'm not seeing errors which look related to this PR. Is there somewhere else I should be looking?

@github-actions github-actions Bot deployed to PR Documentation Preview May 2, 2025 09:52 Active

@anoadragon453 anoadragon453 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor things, but on the whole looks good! Tests are failing due to this PR though, see below.

Comment thread tests/rest/admin/test_room_reports.py Outdated
Comment thread tests/rest/admin/test_room_reports.py Outdated
Comment thread docs/admin_api/room_reports.md Outdated
Comment thread docs/admin_api/room_reports.md Outdated
Comment thread synapse/rest/admin/room_reports.py Outdated
Comment thread tests/rest/admin/test_room_reports.py
Comment thread tests/rest/admin/test_room_reports.py Outdated
turt2live and others added 3 commits May 2, 2025 11:02
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
@github-actions github-actions Bot deployed to PR Documentation Preview May 2, 2025 17:03 Active
@turt2live

Copy link
Copy Markdown
Member Author

Replaced by #19648

@turt2live turt2live closed this Jun 1, 2026
@turt2live turt2live deleted the travis/adminapi-report-room branch June 1, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants