ruma_federation_api/membership/create_leave_event/
v2.rs

Help
1//! `/v2/` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv2send_leaveroomideventid
4
5use ruma_common::{
6    api::{request, response, Metadata},
7    metadata, OwnedEventId, OwnedRoomId,
8};
9use serde_json::value::RawValue as RawJsonValue;
10
11const METADATA: Metadata = metadata! {
12    method: PUT,
13    rate_limited: false,
14    authentication: ServerSignatures,
15    history: {
16        1.0 => "/_matrix/federation/v2/send_leave/:room_id/:event_id",
17    }
18};
19
20/// Request type for the `create_leave_event` endpoint.
21#[request]
22pub struct Request {
23    /// The room ID that is about to be left.
24    ///
25    /// Do not use this. Instead, use the `room_id` field inside the PDU.
26    #[ruma_api(path)]
27    pub room_id: OwnedRoomId,
28
29    /// The event ID for the leave event.
30    #[ruma_api(path)]
31    pub event_id: OwnedEventId,
32
33    /// The PDU.
34    #[ruma_api(body)]
35    pub pdu: Box<RawJsonValue>,
36}
37
38/// Response type for the `create_leave_event` endpoint.
39#[response]
40#[derive(Default)]
41pub struct Response {}
42
43impl Request {
44    /// Creates a new `Request` from the given room ID, event ID and PDU.
45    pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawJsonValue>) -> Self {
46        Self { room_id, event_id, pdu }
47    }
48}
49
50impl Response {
51    /// Creates an empty `Response`.
52    pub fn new() -> Self {
53        Self {}
54    }
55}
56
57#[cfg(all(test, feature = "server"))]
58mod tests {
59    use ruma_common::api::OutgoingResponse;
60
61    use super::Response;
62
63    #[test]
64    fn response_body() {
65        let res = Response::new().try_into_http_response::<Vec<u8>>().unwrap();
66
67        assert_eq!(res.body(), b"{}");
68    }
69}
ruma_federation_api/membership/create_leave_event/v2.rs

ruma_federation_api/membership/create_leave_event/
v2.rs
