From b60efa69dad9c8b1a4e2e306a59b470f10b3f670 Mon Sep 17 00:00:00 2001 From: richvdh Date: Wed, 16 Jun 2021 12:16:14 +0000 Subject: deploy: 0adc2882c1a67419207a500f00c41a94be51857a --- develop/admin_api/README.rst | 4 ++-- develop/admin_api/delete_group.html | 2 +- develop/admin_api/event_reports.html | 4 ++-- develop/admin_api/media_admin_api.html | 4 ++-- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 2 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 40 ++++++++++++++++---------------- 9 files changed, 31 insertions(+), 31 deletions(-) (limited to 'develop/admin_api') diff --git a/develop/admin_api/README.rst b/develop/admin_api/README.rst index 37cee87d32..8d6e76580a 100644 --- a/develop/admin_api/README.rst +++ b/develop/admin_api/README.rst @@ -2,7 +2,7 @@ Admin APIs ========== **Note**: The latest documentation can be viewed `here `_. -See `docs/README.md <../docs/README.md>`_ for more information. +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. @@ -10,5 +10,5 @@ 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 <../docs/usage/administration/admin_api>`_. +`docs/usage/administration/admin_api <../usage/administration/admin_api>`_. diff --git a/develop/admin_api/delete_group.html b/develop/admin_api/delete_group.html index df4409e2b2..9183f1f65f 100644 --- a/develop/admin_api/delete_group.html +++ b/develop/admin_api/delete_group.html @@ -190,7 +190,7 @@ being deleted.

POST /_synapse/admin/v1/delete_group/<group_id>

To use it, you will need to authenticate by providing an access_token for a -server admin: see Admin API.

+server admin: see Admin API.

diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index 868d6b1bf0..fd38d12967 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -188,7 +188,7 @@ 
GET /_synapse/admin/v1/event_reports?from=0&limit=10

To use it, you will need to authenticate by providing an access_token for a -server admin: see Admin API.

+server admin: see Admin API.

It returns a JSON body like the following:

{
     "event_reports": [
@@ -266,7 +266,7 @@ have a canonical alias set.
 
GET /_synapse/admin/v1/event_reports/<report_id>
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

+server admin: see Admin API.

 
It returns a JSON body like the following:

 
{
     "event_id": "$bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY",
diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html
index 86a4c64a79..1f15479ba0 100644
--- a/develop/admin_api/media_admin_api.html
+++ b/develop/admin_api/media_admin_api.html
@@ -217,7 +217,7 @@ However, it only shows media from unencrypted events or rooms.

 
GET /_synapse/admin/v1/room/<room_id>/media
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

+server admin: see Admin API.

 
The API returns a JSON body like the following:

 
{
   "local": [
@@ -414,7 +414,7 @@ All cached media that was last accessed before this timestamp will be removed.deleted: integer - The number of media items successfully deleted
 
 
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

+server admin: see Admin API.

 
If the user re-requests purged remote media, synapse will re-request the media
 from the originating server.

 
diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html
index dc411ec5a7..4d307efc66 100644
--- a/develop/admin_api/purge_history_api.html
+++ b/develop/admin_api/purge_history_api.html
@@ -194,7 +194,7 @@ delete the last message in a room.

 
POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API

+server admin: Admin API

 
By default, events sent by local users are not deleted, as they may represent
 the only copies of this content in existence. (Events sent by remote users are
 deleted.)

diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html
index 08bec4be62..a372df2279 100644
--- a/develop/admin_api/room_membership.html
+++ b/develop/admin_api/room_membership.html
@@ -202,7 +202,7 @@ invite users.

 }
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

+server admin: see Admin API.

 
Response:

 
{
   "room_id": "!636q39766251:server.com"
diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html
index 2c1b5752ba..d5f8515d8a 100644
--- a/develop/admin_api/rooms.html
+++ b/develop/admin_api/rooms.html
@@ -575,7 +575,7 @@ the new room. Users on other servers will be unaffected.

 }
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

+server admin: see Admin API.

 
A response body like the following is returned:

 
{
     "kicked_users": [
diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html
index 79309cc3ec..70aa7e14f1 100644
--- a/develop/admin_api/statistics.html
+++ b/develop/admin_api/statistics.html
@@ -189,7 +189,7 @@ possibility to filter them by time and user.

 
GET /_synapse/admin/v1/statistics/users/media
 

 
To use it, you will need to authenticate by providing an access_token
-for a server admin: see Admin API.

+for a server admin: see Admin API.

 
A response body like the following is returned:

 
{
   "users": [
diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index 7a1cc1143c..cb06b53576 100644
--- a/develop/admin_api/user_admin_api.html
+++ b/develop/admin_api/user_admin_api.html
@@ -189,7 +189,7 @@
 
GET /_synapse/admin/v2/users/<user_id>
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API

+server admin: Admin API

 
It returns a JSON body like the following:

 
{
     "displayname": "User",
@@ -244,7 +244,7 @@ specific user_id.

 }
 

 
To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API

+server admin: Admin API

 
URL parameters:

 
    
 
  • user_id: fully-qualified user id: for example, @user:server.com.
    • 
@@ -285,7 +285,7 @@ By default, the response is ordered by ascending user ID.
    
 
    GET /_synapse/admin/v2/users?from=0&limit=10&guests=false
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
     "users": [
@@ -406,7 +406,7 @@ This allows user type specific behaviour. There are also types supportSee also: Client Server
 API Whois.
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    It returns a JSON body like the following:
    
 
    {
     "user_id": "<user_id>",
@@ -449,7 +449,7 @@ were sent, but hidden from users joining the room afterwards.
    
 }
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    The erase parameter is optional and defaults to false.
 An empty body may be passed for backwards compatibility.
    
 
    The following actions are performed when deactivating an user:
    
@@ -483,7 +483,7 @@ is set to true:
    
 }
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    The parameter new_password is required.
 The parameter logout_devices is optional and defaults to true.
    
 
    Get whether a user is a server administrator or not
    
@@ -491,7 +491,7 @@ The parameter logout_devices is optional and defaults to true
 
    GET /_synapse/admin/v1/users/<user_id>/admin
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
     "admin": true
@@ -508,14 +508,14 @@ server admin: Admin API
    
 }
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    List room memberships of a user
    
 
    Gets a list of all room_id that a specific user_id is member.
    
 
    The API is:
    
 
    GET /_synapse/admin/v1/users/<user_id>/joined_rooms
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
        {
         "joined_rooms": [
@@ -548,7 +548,7 @@ The newest media is on top. You can change the order with parameters
 
    GET /_synapse/admin/v1/users/<user_id>/media
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "media": [
@@ -699,7 +699,7 @@ same.
    
 
    GET /_synapse/admin/v2/users/<user_id>/devices
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "devices": [
@@ -761,7 +761,7 @@ any access token associated with them.
    
 }
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    An empty JSON dict is returned.
    
 
    Parameters
    
 
    The following parameters should be set in the URL:
    
@@ -778,7 +778,7 @@ server admin: Admin API
    
 
    GET /_synapse/admin/v2/users/<user_id>/devices/<device_id>
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "device_id": "<device_id>",
@@ -816,7 +816,7 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons
 }
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    An empty JSON dict is returned.
    
 
    Parameters
    
 
    The following parameters should be set in the URL:
    
@@ -838,7 +838,7 @@ and invalidates any access token associated with it.
    
 {}
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    An empty JSON dict is returned.
    
 
    Parameters
    
 
    The following parameters should be set in the URL:
    
@@ -852,7 +852,7 @@ server admin: Admin API
    
 
    GET /_synapse/admin/v1/users/<user_id>/pushers
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "pushers": [
@@ -949,7 +949,7 @@ A shadow-banned user will be unable to contact anyone on the server.
    
 
    POST /_synapse/admin/v1/users/<user_id>/shadow_ban
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    An empty JSON dict is returned.
    
 
    Parameters
    
 
    The following parameters should be set in the URL:
    
@@ -965,7 +965,7 @@ There are specific APIs to set, get and delete a ratelimit.
    
 
    GET /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "messages_per_second": 0,
@@ -994,7 +994,7 @@ being limited.
 
    POST /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    A response body like the following is returned:
    
 
    {
   "messages_per_second": 0,
@@ -1028,7 +1028,7 @@ being limited.
 
    DELETE /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
    
 
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
+server admin: Admin API
    
 
    An empty JSON dict is returned.
    
 
    {}
 
    
-- 
cgit 1.5.1