Rearrange admin API fs heirarchy to match sidebar
I've kept the RST redirect file in-place though
This commit is contained in:
@@ -51,21 +51,21 @@
|
||||
- [Using `synctl` with Workers](usage/configuration/synctl_workers.md)
|
||||
- [Systemd](usage/configuration/systemd-with-workers/README.md)
|
||||
- [Administration](administration/README.md)
|
||||
- [Admin API](usage/administration/admin_api/README.md)
|
||||
- [Account Validity](admin_api/account_validity.md)
|
||||
- [Background Updates](usage/administration/admin_api/background_updates.md)
|
||||
- [Event Reports](admin_api/event_reports.md)
|
||||
- [Media](admin_api/media_admin_api.md)
|
||||
- [Purge History](admin_api/purge_history_api.md)
|
||||
- [Register Users](admin_api/register_api.md)
|
||||
- [Registration Tokens](usage/administration/admin_api/registration_tokens.md)
|
||||
- [Manipulate Room Membership](admin_api/room_membership.md)
|
||||
- [Rooms](admin_api/rooms.md)
|
||||
- [Server Notices](admin_api/server_notices.md)
|
||||
- [Statistics](admin_api/statistics.md)
|
||||
- [Users](admin_api/user_admin_api.md)
|
||||
- [Server Version](admin_api/version_api.md)
|
||||
- [Federation](usage/administration/admin_api/federation.md)
|
||||
- [Admin API](administration/admin_api/README.md)
|
||||
- [Account Validity](administration/admin_api/account_validity.md)
|
||||
- [Background Updates](administration/admin_api/background_updates.md)
|
||||
- [Event Reports](administration/admin_api/event_reports.md)
|
||||
- [Media](administration/admin_api/media_admin_api.md)
|
||||
- [Purge History](administration/admin_api/purge_history_api.md)
|
||||
- [Register Users](administration/admin_api/register_api.md)
|
||||
- [Registration Tokens](administration/admin_api/registration_tokens.md)
|
||||
- [Manipulate Room Membership](administration/admin_api/room_membership.md)
|
||||
- [Rooms](administration/admin_api/rooms.md)
|
||||
- [Server Notices](administration/admin_api/server_notices.md)
|
||||
- [Statistics](administration/admin_api/statistics.md)
|
||||
- [Users](administration/admin_api/user_admin_api.md)
|
||||
- [Server Version](administration/admin_api/version_api.md)
|
||||
- [Federation](administration/admin_api/federation.md)
|
||||
- [Manhole](administration/manhole.md)
|
||||
- [Monitoring](administration/metrics-howto.md)
|
||||
- [Reporting Homeserver Usage Statistics](administration/reporting_homeserver_usage_statistics.md)
|
||||
|
||||
@@ -106,4 +106,4 @@ The following JSON body parameters are available:
|
||||
|
||||
- `job_name` - A string which job to run. Valid values are:
|
||||
- `populate_stats_process_rooms` - Recalculate the stats for all rooms.
|
||||
- `regenerate_directory` - Recalculate the [user directory](../../configuration/user_directory.md) if it is stale or out of sync.
|
||||
- `regenerate_directory` - Recalculate the [user directory](../../usage/configuration/user_directory.md) if it is stale or out of sync.
|
||||
@@ -3,7 +3,7 @@
|
||||
These APIs allow extracting media information from the homeserver.
|
||||
|
||||
Details about the format of the `media_id` and storage of the media in the file system
|
||||
are documented under [media repository](../development/internal_documentation/media_repository.md).
|
||||
are documented under [media repository](../../development/internal_documentation/media_repository.md).
|
||||
|
||||
To use it, you will need to authenticate by providing an `access_token`
|
||||
for a server admin: see [Admin API](../usage/administration/admin_api).
|
||||
@@ -5,7 +5,7 @@ non-interactive way. This is generally used for bootstrapping a Synapse
|
||||
instance with administrator accounts.
|
||||
|
||||
To authenticate yourself to the server, you will need both the shared secret
|
||||
([`registration_shared_secret`](../usage/configuration/config_documentation.md#registration_shared_secret)
|
||||
([`registration_shared_secret`](../../usage/configuration/config_documentation.md#registration_shared_secret)
|
||||
in the homeserver configuration), and a one-time nonce. If the registration
|
||||
shared secret is not configured, this API is not enabled.
|
||||
|
||||
@@ -6,7 +6,7 @@ registration requests, as proposed in
|
||||
and stabilised in version 1.2 of the Matrix specification.
|
||||
To use it, you will need to enable the `registration_requires_token` config
|
||||
option, and authenticate by providing an `access_token` for a server admin:
|
||||
see [Admin API](../admin_api).
|
||||
see [Admin API](../usage/administration/admin_api).
|
||||
|
||||
|
||||
## Registration token objects
|
||||
@@ -45,4 +45,4 @@ Once the notice has been sent, the API will return the following response:
|
||||
```
|
||||
|
||||
Note that server notices must be enabled in `homeserver.yaml` before this API
|
||||
can be used. See [the server notices documentation](../usage/configuration/server_notices.md) for more information.
|
||||
can be used. See [the server notices documentation](../../usage/configuration/server_notices.md) for more information.
|
||||
@@ -127,7 +127,7 @@ Body parameters:
|
||||
belonging to a user.
|
||||
- `external_ids` - array, optional. Allow setting the identifier of the external identity
|
||||
provider for SSO (Single sign-on). Details in the configuration manual under the
|
||||
sections [sso](../usage/configuration/config_documentation.md#sso) and [oidc_providers](../usage/configuration/config_documentation.md#oidc_providers).
|
||||
sections [sso](../../usage/configuration/config_documentation.md#sso) and [oidc_providers](../../usage/configuration/config_documentation.md#oidc_providers).
|
||||
- `auth_provider` - string. ID of the external identity provider. Value of `idp_id`
|
||||
in the homeserver configuration. Note that no error is raised if the provided
|
||||
value is not in the homeserver configuration.
|
||||
@@ -548,9 +548,9 @@ The following fields are returned in the JSON response body:
|
||||
### List media uploaded by a user
|
||||
Gets a list of all local media that a specific `user_id` has created.
|
||||
These are media that the user has uploaded themselves
|
||||
([local media](../development/internal_documentation/media_repository.md#local-media)), as well as
|
||||
[URL preview images](../development/internal_documentation/media_repository.md#url-previews) requested by the user if the
|
||||
[feature is enabled](../usage/configuration/config_documentation.md#url_preview_enabled).
|
||||
([local media](../../development/internal_documentation/media_repository.md#local-media)), as well as
|
||||
[URL preview images](../../development/internal_documentation/media_repository.md#url-previews) requested by the user if the
|
||||
[feature is enabled](../../usage/configuration/config_documentation.md#url_preview_enabled).
|
||||
|
||||
By default, the response is ordered by descending creation date and ascending media ID.
|
||||
The newest media is on top. You can change the order with parameters
|
||||
@@ -650,7 +650,7 @@ The following fields are returned in the JSON response body:
|
||||
- `last_access_ts` - integer - Timestamp when the content was last accessed in ms.
|
||||
- `media_id` - string - The id used to refer to the media. Details about the format
|
||||
are documented under
|
||||
[media repository](../development/internal_documentation/media_repository.md).
|
||||
[media repository](../../development/internal_documentation/media_repository.md).
|
||||
- `media_length` - integer - Length of the media in bytes.
|
||||
- `media_type` - string - The MIME-type of the media.
|
||||
- `quarantined_by` - string - The user ID that initiated the quarantine request
|
||||
@@ -1702,9 +1702,9 @@ and the original media will be removed. If either of these options are unset,
|
||||
then media of that type will not be purged.
|
||||
|
||||
Local or cached remote media that has been
|
||||
[quarantined](../../admin_api/media_admin_api.md#quarantining-media-in-a-room)
|
||||
[quarantined](../../administration/admin_api/media_admin_api.md#quarantining-media-in-a-room)
|
||||
will not be deleted. Similarly, local media that has been marked as
|
||||
[protected from quarantine](../../admin_api/media_admin_api.md#protecting-media-from-being-quarantined)
|
||||
[protected from quarantine](../../administration/admin_api/media_admin_api.md#protecting-media-from-being-quarantined)
|
||||
will not be deleted.
|
||||
|
||||
Example configuration:
|
||||
@@ -2068,7 +2068,7 @@ enable_3pid_lookup: false
|
||||
### `registration_requires_token`
|
||||
|
||||
Require users to submit a token during registration.
|
||||
Tokens can be managed using the admin [API](../administration/admin_api/registration_tokens.md).
|
||||
Tokens can be managed using the admin [API](../../administration/admin_api/registration_tokens.md).
|
||||
Disabling this option will not delete any tokens previously generated.
|
||||
Defaults to `false`. Set to `true` to enable.
|
||||
|
||||
@@ -3425,7 +3425,7 @@ This option has the following sub-options:
|
||||
|
||||
These indexes are built the first time Synapse starts; admins can
|
||||
manually trigger a rebuild via the API following the instructions
|
||||
[for running background updates](../administration/admin_api/background_updates.md#run),
|
||||
[for running background updates](../../administration/admin_api/background_updates.md#run),
|
||||
set to true to return search results containing all known users, even if that
|
||||
user does not share a room with the requester.
|
||||
* `prefer_local_users`: Defines whether to prefer local users in search query results.
|
||||
|
||||
@@ -7,7 +7,7 @@ who are present in a publicly viewable room present on the server.
|
||||
|
||||
The directory info is stored in various tables, which can (typically after
|
||||
DB corruption) get stale or out of sync. If this happens, for now the
|
||||
solution to fix it is to use the [admin API](../administration/admin_api/background_updates.md#run)
|
||||
solution to fix it is to use the [admin API](../../administration/admin_api/background_updates.md#run)
|
||||
and execute the job `regenerate_directory`. This should then start a background task to
|
||||
flush the current tables and regenerate the directory.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user