69 lines
2.1 KiB
Rust
69 lines
2.1 KiB
Rust
//! `DELETE /_matrix/client/*/room_keys/keys/{roomId}/{sessionId}`
|
|
|
|
pub mod v3 {
|
|
//! `/v3/` ([spec])
|
|
//!
|
|
//! [spec]: https://spec.matrix.org/v1.2/client-server-api/#delete_matrixclientv3room_keyskeysroomidsessionid
|
|
|
|
use js_int::UInt;
|
|
use ruma_api::ruma_api;
|
|
use ruma_identifiers::RoomId;
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Delete a key from the backup",
|
|
method: DELETE,
|
|
name: "delete_backup_key_session",
|
|
unstable_path: "/_matrix/client/unstable/room_keys/keys/:room_id/:session_id",
|
|
r0_path: "/_matrix/client/r0/room_keys/keys/:room_id/:session_id",
|
|
stable_path: "/_matrix/client/v3/room_keys/keys/:room_id/:session_id",
|
|
rate_limited: true,
|
|
authentication: AccessToken,
|
|
added: 1.0,
|
|
}
|
|
|
|
request: {
|
|
/// The backup version.
|
|
///
|
|
/// Must be the current backup.
|
|
#[ruma_api(query)]
|
|
pub version: &'a str,
|
|
|
|
/// The ID of the room that the requested key is for.
|
|
#[ruma_api(path)]
|
|
pub room_id: &'a RoomId,
|
|
|
|
/// The ID of the megolm session whose key is requested.
|
|
#[ruma_api(path)]
|
|
pub session_id: &'a str,
|
|
}
|
|
|
|
response: {
|
|
/// An opaque string representing stored keys in the backup.
|
|
///
|
|
/// Clients can compare it with the etag value they received in the request of their last
|
|
/// key storage request.
|
|
pub etag: String,
|
|
|
|
/// The number of keys stored in the backup.
|
|
pub count: UInt,
|
|
}
|
|
|
|
error: crate::Error
|
|
}
|
|
|
|
impl<'a> Request<'a> {
|
|
/// Creates a new `Request` with the given version, room_id and session_id.
|
|
pub fn new(version: &'a str, room_id: &'a RoomId, session_id: &'a str) -> Self {
|
|
Self { version, room_id, session_id }
|
|
}
|
|
}
|
|
|
|
impl Response {
|
|
/// Creates an new `Response` with the given etag and count.
|
|
pub fn new(etag: String, count: UInt) -> Self {
|
|
Self { etag, count }
|
|
}
|
|
}
|
|
}
|