0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-24 07:24:11 +01:00
synapse/docs/admin_api
Tadeusz Sośnierz 1433b5d5b6
Show erasure status when listing users in the Admin API (#14205)
* Show erasure status when listing users in the Admin API

* Use USING when joining erased_users

* Add changelog entry

* Revert "Use USING when joining erased_users"

This reverts commit 30bd2bf106415caadcfdbdd1b234ef2b106cc394.

* Make the erased check work on postgres

* Add a testcase for showing erased user status

* Appease the style linter

* Explicitly convert `erased` to bool to make SQLite consistent with Postgres

This also adds us an easy way in to fix the other accidentally integered columns.

* Move erasure status test to UsersListTestCase

* Include user erased status when fetching user info via the admin API

* Document the erase status in user_admin_api

* Appease the linter and mypy

* Signpost comments in tests

Co-authored-by: Tadeusz Sośnierz <tadeusz@sosnierz.com>
Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
2022-10-21 13:52:44 +01:00
..
account_validity.md Consolidate the access_token information in the admin api (#11861) 2022-01-31 16:24:29 +00:00
event_reports.md Consolidate the access_token information in the admin api (#11861) 2022-01-31 16:24:29 +00:00
media_admin_api.md Fix reference to the wrong symbol in the media admin api docs (#12715) 2022-05-12 09:29:37 +01:00
purge_history_api.md Consolidate the access_token information in the admin api (#11861) 2022-01-31 16:24:29 +00:00
README.rst Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
register_api.md Fix the cross-link from register admin API to config docs. (#13870) 2022-09-22 09:11:50 -04:00
room_membership.md Consolidate the access_token information in the admin api (#11861) 2022-01-31 16:24:29 +00:00
rooms.md Add Admin API to Fetch Messages Within a Particular Window (#13672) 2022-09-07 10:54:44 +01:00
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
statistics.md Consolidate the access_token information in the admin api (#11861) 2022-01-31 16:24:29 +00:00
user_admin_api.md Show erasure status when listing users in the Admin API (#14205) 2022-10-21 13:52:44 +01:00
version_api.md Drop support for and remove references to EOL Python 3.6 (#11683) 2022-01-21 14:23:26 -08:00

Admin APIs
==========

**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_.
See `docs/README.md <../README.md>`_ for more information.

**Please update links to point to the website instead.** Existing files in this directory
are preserved to maintain historical links, but may be moved in the future.

This directory includes documentation for the various synapse specific admin
APIs available. Updates to the existing Admin API documentation should still
be made to these files, but any new documentation files should instead be placed under
`docs/usage/administration/admin_api <../usage/administration/admin_api>`_.