From 5eb02d99baebd79c755db37418b1fcb0b1fea42a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Sun, 26 Oct 2025 17:19:55 +0100 Subject: [PATCH] Fix links to Synapse Admin API docs Point to the new repository maintained by Element instead of the one that was under Matrix.org that was archived. The files now also have the `.md` extension rather than `.rst`. And a few URL fragments have changed. --- README.md | 2 +- src/account_validity/renew_account/v1.rs | 2 +- src/lib.rs | 2 +- src/register_users/shared_secret_register/v1.rs | 4 ++-- src/register_users/shared_secret_register_nonce/v1.rs | 2 +- src/users/create_or_modify/v2.rs | 2 +- src/users/deactivate_account/v1.rs | 2 +- src/users/get_details/v2.rs | 2 +- src/users/is_user_admin/v1.rs | 2 +- src/users/list_joined_rooms/v1.rs | 2 +- src/users/list_users/v2.rs | 2 +- src/users/reset_password/v1.rs | 2 +- 12 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 893e437..be8b0e1 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,4 @@ [![docs.rs page](https://docs.rs/synapse-admin-api/badge.svg)](https://docs.rs/synapse-admin-api/) ![license: MIT](https://img.shields.io/crates/l/synapse-admin-api.svg) -**synapse-admin-api** contains serializable types for the requests and responses for each endpoint in the [synapse admin API](https://github.com/matrix-org/synapse/tree/master/docs/admin_api). +**synapse-admin-api** contains serializable types for the requests and responses for each endpoint in the [synapse admin API](https://github.com/element-hq/synapse/tree/master/docs/admin_api). diff --git a/src/account_validity/renew_account/v1.rs b/src/account_validity/renew_account/v1.rs index a0df24e..4c14d11 100644 --- a/src/account_validity/renew_account/v1.rs +++ b/src/account_validity/renew_account/v1.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v1/account_validity/validity](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/account_validity.rst) +//! [GET /_synapse/admin/v1/account_validity/validity](https://github.com/element-hq/synapse/blob/master/docs/admin_api/account_validity.md) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/lib.rs b/src/lib.rs index 5e4f046..812beb5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -15,7 +15,7 @@ //! compiles all types as exhaustive. By enabling this feature you opt out of all semver //! guarantees synapse-admin-api otherwise provides. //! -//! [api]: https://github.com/matrix-org/synapse/tree/master/docs/admin_api +//! [api]: https://github.com/element-hq/synapse/tree/master/docs/admin_api // FIXME: don't allow dead code, warn on missing docs #![allow(dead_code)] diff --git a/src/register_users/shared_secret_register/v1.rs b/src/register_users/shared_secret_register/v1.rs index e21fa6f..dd9f884 100644 --- a/src/register_users/shared_secret_register/v1.rs +++ b/src/register_users/shared_secret_register/v1.rs @@ -1,4 +1,4 @@ -//! [POST /_synapse/admin/v1/register](https://matrix-org.github.io/synapse/latest/admin_api/register_api.html#shared-secret-registration) +//! [POST /_synapse/admin/v1/register](https://github.com/element-hq/synapse/blob/master/docs/admin_api/register_api.md) #[cfg(feature = "shared-secret-registration-mac")] use hmac::{digest::InvalidLength, Hmac, Mac}; @@ -89,7 +89,7 @@ impl Response { /// Calculate the MAC based on the given inputs. /// -/// See for details. +/// See for details. #[cfg(feature = "shared-secret-registration-mac")] pub fn hmac( registration_shared_secret: &str, diff --git a/src/register_users/shared_secret_register_nonce/v1.rs b/src/register_users/shared_secret_register_nonce/v1.rs index 60071d7..73721e4 100644 --- a/src/register_users/shared_secret_register_nonce/v1.rs +++ b/src/register_users/shared_secret_register_nonce/v1.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v1/register](https://matrix-org.github.io/synapse/latest/admin_api/register_api.html#shared-secret-registration) +//! [GET /_synapse/admin/v1/register](https://github.com/element-hq/synapse/blob/master/docs/admin_api/register_api.md) use ruma::api::{metadata, request, response, Metadata}; diff --git a/src/users/create_or_modify/v2.rs b/src/users/create_or_modify/v2.rs index 6d292ec..614b1ef 100644 --- a/src/users/create_or_modify/v2.rs +++ b/src/users/create_or_modify/v2.rs @@ -1,4 +1,4 @@ -//! [PUT /_synapse/admin/v2/users/:user_id](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#create-or-modify-account) +//! [PUT /_synapse/admin/v2/users/:user_id](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#create-or-modify-account) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/deactivate_account/v1.rs b/src/users/deactivate_account/v1.rs index 31c7cb3..5918cef 100644 --- a/src/users/deactivate_account/v1.rs +++ b/src/users/deactivate_account/v1.rs @@ -1,4 +1,4 @@ -//! [POST /_synapse/admin/v1/deactivate/:user_id](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/user_admin_api.rst#deactivate-account) +//! [POST /_synapse/admin/v1/deactivate/:user_id](https://github.com/element-hq/synapse/blob/develop/docs/admin_api/user_admin_api.md#deactivate-account) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/get_details/v2.rs b/src/users/get_details/v2.rs index a252d26..179870e 100644 --- a/src/users/get_details/v2.rs +++ b/src/users/get_details/v2.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v2/users/:user_id](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#query-user-account) +//! [GET /_synapse/admin/v2/users/:user_id](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#query-user-account) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/is_user_admin/v1.rs b/src/users/is_user_admin/v1.rs index ef9da65..9223c1d 100644 --- a/src/users/is_user_admin/v1.rs +++ b/src/users/is_user_admin/v1.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v1/users/:user_id/admin](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#get-whether-a-user-is-a-server-administrator-or-not) +//! [GET /_synapse/admin/v1/users/:user_id/admin](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#get-whether-a-user-is-a-server-administrator-or-not) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/list_joined_rooms/v1.rs b/src/users/list_joined_rooms/v1.rs index 5d9c5cc..fbc66cd 100644 --- a/src/users/list_joined_rooms/v1.rs +++ b/src/users/list_joined_rooms/v1.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v1/users/:user_id/joined_rooms](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-room-memberships-of-an-user) +//! [GET /_synapse/admin/v1/users/:user_id/joined_rooms](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#list-joined-rooms-of-a-user) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/list_users/v2.rs b/src/users/list_users/v2.rs index a615772..7c58360 100644 --- a/src/users/list_users/v2.rs +++ b/src/users/list_users/v2.rs @@ -1,4 +1,4 @@ -//! [GET /_synapse/admin/v2/users/:user_id](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-accountshttps://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#query-user-account) +//! [GET /_synapse/admin/v2/users](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#list-accounts) use ruma::{ api::{metadata, request, response, Metadata}, diff --git a/src/users/reset_password/v1.rs b/src/users/reset_password/v1.rs index b887906..7b9f84c 100644 --- a/src/users/reset_password/v1.rs +++ b/src/users/reset_password/v1.rs @@ -1,4 +1,4 @@ -//! [POST /_synapse/admin/v1/reset_password/:user_id](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#reset-password) +//! [POST /_synapse/admin/v1/reset_password/:user_id](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#reset-password) use ruma::{ api::{metadata, request, response, Metadata},