2022-11-12 10:17:24 +01:00

55 lines
1.5 KiB
Rust

//! `POST /_matrix/client/*/rooms/{roomId}/upgrade`
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.4/client-server-api/#post_matrixclientv3roomsroomidupgrade
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedRoomId, RoomId, RoomVersionId,
};
const METADATA: Metadata = metadata! {
description: "Upgrades a room to a particular version.",
method: POST,
name: "upgrade_room",
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/:room_id/upgrade",
1.1 => "/_matrix/client/v3/rooms/:room_id/upgrade",
}
};
#[request(error = crate::Error)]
pub struct Request<'a> {
/// ID of the room to be upgraded.
#[ruma_api(path)]
pub room_id: &'a RoomId,
/// New version for the room.
pub new_version: &'a RoomVersionId,
}
#[response(error = crate::Error)]
pub struct Response {
/// ID of the new room.
pub replacement_room: OwnedRoomId,
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given room ID and new room version.
pub fn new(room_id: &'a RoomId, new_version: &'a RoomVersionId) -> Self {
Self { room_id, new_version }
}
}
impl Response {
/// Creates a new `Response` with the given room ID.
pub fn new(replacement_room: OwnedRoomId) -> Self {
Self { replacement_room }
}
}
}