From 9f273f34d4ac64ef9d47721b04187ed273fc998d Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Thu, 29 Jul 2021 10:09:19 +0000 Subject: deploy: c36c2777900284cf94e93e60e34c3b856bb31551 --- latest/admin_api/media_admin_api.html | 4 +- latest/admin_api/rooms.html | 69 ++++++++++++----------------------- latest/admin_api/server_notices.html | 2 +- 3 files changed, 26 insertions(+), 49 deletions(-) (limited to 'latest/admin_api') diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 1dad17fbaf..0ee4e43183 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -232,7 +232,7 @@ server admin: see Admin API.

List all media uploaded by a user

Listing all media that has been uploaded by a local user can be achieved through -the use of the List media of a user +the use of the List media of a user Admin API.

Quarantine media

Quarantining media means that it is marked as inaccessible by users. It applies @@ -371,7 +371,7 @@ See also Purge Remote Media API.

  • server_name: string - The name of your local server (e.g matrix.org).
  • before_ts: string representing a positive integer - Unix timestamp in ms. Files that were last used before this timestamp will be deleted. It is the timestamp of -last access and not the timestamp creation.
  • +last access and not the timestamp creation.
  • size_gt: Optional - string representing a positive integer - Size of the media in bytes. Files that are larger will be deleted. Defaults to 0.
  • keep_profiles: Optional - string representing a boolean - Switch to also delete files diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index 6f8687e7e2..365339e4aa 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -184,19 +184,12 @@

    Contents

    -

    Usage

    -

    A standard request:

    +

    The API is:

    GET /_synapse/admin/v1/rooms/<room_id>
    -
    -{}
     
    -

    Response:

    +

    A response body like the following is returned:

    {
       "room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
       "name": "Music Theory",
    @@ -507,13 +490,10 @@ end of the list.

  • members - A list of all the members that are present in the room, represented by their ids.
  • total - Total number of members in the room.
  • -

    Usage

    -

    A standard request:

    +

    The API is:

    GET /_synapse/admin/v1/rooms/<room_id>/members
    -
    -{}
     
    -

    Response:

    +

    A response body like the following is returned:

    {
       "members": [
         "@foo:matrix.org",
    @@ -529,13 +509,10 @@ end of the list.

    • state - The current state of the room at the time of request.
    -

    Usage

    -

    A standard request:

    +

    The API is:

    GET /_synapse/admin/v1/rooms/<room_id>/state
    -
    -{}
     
    -

    Response:

    +

    A response body like the following is returned:

    {
       "state": [
         {"type": "m.room.create", "state_key": "", "etc": true},
    @@ -589,7 +566,7 @@ server admin: see Admin API.

    "new_room_id": "!newroomid:example.com" }
    -

    Parameters

    +

    Parameters

    The following parameters should be set in the URL:

    • room_id - The ID of the room.
    • @@ -616,7 +593,7 @@ use this unless a regular purge operation fails, as it could leave clients in a confused state.

    The JSON body must not be empty. The body must be at least {}.

    -

    Response

    +

    Response

    The following fields are returned in the JSON response body: