api: Clarify that access tokens using query parameter are deprecated

According to MSC4126 / Matrix 1.11
This commit is contained in:
Kévin Commaille 2024-06-21 02:58:33 +02:00 committed by Kévin Commaille
parent ffc1cb1c4d
commit 05c12bf3ba
2 changed files with 5 additions and 3 deletions

View File

@ -13,6 +13,8 @@ Improvements:
- Implement `Eq`/`Hash`/`PartialEq` for `ThirdPartyIdentifier`, to check whether
a `ThirdPartyIdentifier` has already been added by another user.
- Add `MatrixVersion::V1_11`
- Clarify in the docs of `AuthScheme` that sending an access token via a query
parameter is deprecated, according to MSC4126 / Matrix 1.11.
# 0.13.0

View File

@ -497,19 +497,19 @@ pub enum AuthScheme {
/// Authentication is performed by including an access token in the `Authentication` http
/// header, or an `access_token` query parameter.
///
/// It is recommended to use the header over the query parameter.
/// Using the query parameter is deprecated since Matrix 1.11.
AccessToken,
/// Authentication is optional, and it is performed by including an access token in the
/// `Authentication` http header, or an `access_token` query parameter.
///
/// It is recommended to use the header over the query parameter.
/// Using the query parameter is deprecated since Matrix 1.11.
AccessTokenOptional,
/// Authentication is only performed for appservices, by including an access token in the
/// `Authentication` http header, or an `access_token` query parameter.
///
/// It is recommended to use the header over the query parameter.
/// Using the query parameter is deprecated since Matrix 1.11.
AppserviceToken,
/// Authentication is performed by including X-Matrix signatures in the request headers,