Update register endpoint to r0.6.0

This commit is contained in:
Isaiah Inuwa 2020-04-06 14:10:35 -05:00 committed by Jonas Platte
parent dc582758e4
commit abcc8ec1d2
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
2 changed files with 13 additions and 10 deletions

View File

@ -3,6 +3,10 @@
Breaking changes: Breaking changes:
* Add `server_name` parameter to `r0::join::join_room_by_id_or_alias` * Add `server_name` parameter to `r0::join::join_room_by_id_or_alias`
* Update `r0::account::register` endpoint:
* Remove `bind_email` request field (removed in r0.6.0)
* Remove `inhibit_login` request field, make `access_token` and `device_id` response fields optional (added in r0.4.0)
* Remove deprecated `home_server` response field (removed in r0.4.0)
# 0.7.2 # 0.7.2

View File

@ -1,4 +1,4 @@
//! [POST /_matrix/client/r0/register](https://matrix.org/docs/spec/client_server/r0.4.0.html#post-matrix-client-r0-register) //! [POST /_matrix/client/r0/register](https://matrix.org/docs/spec/client_server/r0.6.0#post-matrix-client-r0-register)
use ruma_api::ruma_api; use ruma_api::ruma_api;
use ruma_identifiers::{DeviceId, UserId}; use ruma_identifiers::{DeviceId, UserId};
@ -17,10 +17,6 @@ ruma_api! {
} }
request { request {
/// If true, the server binds the email used for authentication
/// to the Matrix ID with the ID Server.
#[serde(skip_serializing_if = "Option::is_none")]
pub bind_email: Option<bool>,
/// The desired password for the account. /// The desired password for the account.
/// ///
/// Should only be empty for guest accounts. /// Should only be empty for guest accounts.
@ -53,25 +49,28 @@ ruma_api! {
pub auth: Option<AuthenticationData>, pub auth: Option<AuthenticationData>,
/// Kind of account to register /// Kind of account to register
/// ///
/// Defaults to `User` if ommited. /// Defaults to `User` if omitted.
#[ruma_api(query)] #[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub kind: Option<RegistrationKind>, pub kind: Option<RegistrationKind>,
/// If `true`, an `access_token` and `device_id` should not be returned
/// from this call, therefore preventing an automatic login.
#[serde(default, skip_serializing_if = "crate::serde::is_default")]
pub inhibit_login: bool,
} }
response { response {
/// An access token for the account. /// An access token for the account.
/// ///
/// This access token can then be used to authorize other requests. /// This access token can then be used to authorize other requests.
pub access_token: String, #[serde(skip_serializing_if = "Option::is_none")]
/// The hostname of the homeserver on which the account has been registered. pub access_token: Option<String>,
pub home_server: String,
/// The fully-qualified Matrix ID that has been registered. /// The fully-qualified Matrix ID that has been registered.
pub user_id: UserId, pub user_id: UserId,
/// ID of the registered device. /// ID of the registered device.
/// ///
/// Will be the same as the corresponding parameter in the request, if one was specified. /// Will be the same as the corresponding parameter in the request, if one was specified.
pub device_id: DeviceId, pub device_id: Option<DeviceId>,
} }
error: crate::Error error: crate::Error