ruma_federation_api/membership/create_leave_event/
v1.rs

Help
1//! `/v1/` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv1send_leaveroomideventid
4
5use ruma_common::{
6    api::{request, response, Metadata},
7    metadata, OwnedEventId, OwnedRoomId,
8};
9use serde::{Deserialize, Serialize};
10use serde_json::value::RawValue as RawJsonValue;
11
12const METADATA: Metadata = metadata! {
13    method: PUT,
14    rate_limited: false,
15    authentication: ServerSignatures,
16    history: {
17        1.0 => "/_matrix/federation/v1/send_leave/:room_id/:event_id",
18        1.0 => deprecated,
19    }
20};
21
22/// Request type for the `create_leave_event` endpoint.
23#[request]
24#[deprecated = "Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead."]
25pub struct Request {
26    /// The room ID that is about to be left.
27    ///
28    /// Do not use this. Instead, use the `room_id` field inside the PDU.
29    #[ruma_api(path)]
30    pub room_id: OwnedRoomId,
31
32    /// The event ID for the leave event.
33    #[ruma_api(path)]
34    pub event_id: OwnedEventId,
35
36    /// The PDU.
37    #[ruma_api(body)]
38    pub pdu: Box<RawJsonValue>,
39}
40
41/// Response type for the `create_leave_event` endpoint.
42#[response]
43#[derive(Default)]
44#[deprecated = "Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead."]
45pub struct Response {
46    /// An empty object.
47    ///
48    /// Indicates that the event was accepted into the event graph.
49    #[ruma_api(body)]
50    #[serde(with = "crate::serde::v1_pdu")]
51    pub empty: Empty,
52}
53
54#[allow(deprecated)]
55impl Request {
56    /// Creates a new `Request` from the given room ID, event ID and PDU.
57    pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawJsonValue>) -> Self {
58        Self { room_id, event_id, pdu }
59    }
60}
61
62#[allow(deprecated)]
63impl Response {
64    /// Creates an empty `Response`.
65    pub fn new() -> Self {
66        Self { empty: Empty {} }
67    }
68}
69
70/// An empty object.
71#[derive(Clone, Debug, Default, Deserialize, Serialize)]
72#[allow(clippy::exhaustive_structs)]
73pub struct Empty {}
74
75impl Empty {
76    /// Create a new `Empty`.
77    pub fn new() -> Self {
78        Self {}
79    }
80}
ruma_federation_api/membership/create_leave_event/v1.rs

ruma_federation_api/membership/create_leave_event/
v1.rs
