From 69134c21e56622277dc12bb81a0cfd1354867b05 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Commaille?=
 <76261501+zecakeh@users.noreply.github.com>
Date: Thu, 10 Feb 2022 14:43:14 +0100
Subject: [PATCH] federation-api: Move knock out of unstable-pre-spec

---
 crates/ruma-federation-api/CHANGELOG.md         |  5 +++++
 .../src/knock/create_knock_event_template/v1.rs |  2 +-
 .../src/knock/send_knock/v1.rs                  | 17 +++++++----------
 crates/ruma-federation-api/src/lib.rs           |  1 -
 4 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/crates/ruma-federation-api/CHANGELOG.md b/crates/ruma-federation-api/CHANGELOG.md
index 6b5e5e4b..eb923fb0 100644
--- a/crates/ruma-federation-api/CHANGELOG.md
+++ b/crates/ruma-federation-api/CHANGELOG.md
@@ -7,6 +7,11 @@ Breaking changes:
 * Make `device_display_name` field optional in `DeviceListUpdateContent` and update constructor accordingly
 * Remove unneeded `minimum_valid_until_ts` query parameter from `get_remote_server_keys_batch` endpoint
 
+Improvements:
+
+* Move `knock` module out of `unstable-pre-spec`
+  * `knock:::send_knock::v1::Request` requires a PDU instead of the `knock_event`
+
 # 0.3.1
 
 Bug fixes:
diff --git a/crates/ruma-federation-api/src/knock/create_knock_event_template/v1.rs b/crates/ruma-federation-api/src/knock/create_knock_event_template/v1.rs
index ba54f538..4d1c79d5 100644
--- a/crates/ruma-federation-api/src/knock/create_knock_event_template/v1.rs
+++ b/crates/ruma-federation-api/src/knock/create_knock_event_template/v1.rs
@@ -1,4 +1,4 @@
-//! [GET /_matrix/federation/v1/make_knock/{roomId}/{userId}](https://spec.matrix.org/unstable/server-server-api/#get_matrixfederationv1make_knockroomiduserid)
+//! [GET /_matrix/federation/v1/make_knock/{roomId}/{userId}](https://spec.matrix.org/v1.1/server-server-api/#get_matrixfederationv1make_knockroomiduserid)
 
 use ruma_api::ruma_api;
 use ruma_identifiers::{RoomId, RoomVersionId, UserId};
diff --git a/crates/ruma-federation-api/src/knock/send_knock/v1.rs b/crates/ruma-federation-api/src/knock/send_knock/v1.rs
index 913fd863..ae08c52b 100644
--- a/crates/ruma-federation-api/src/knock/send_knock/v1.rs
+++ b/crates/ruma-federation-api/src/knock/send_knock/v1.rs
@@ -1,8 +1,9 @@
-//! [PUT /_matrix/federation/v1/send_knock/{roomId}/{eventId}](https://spec.matrix.org/unstable/server-server-api/#put_matrixfederationv1send_knockroomideventid)
+//! [PUT /_matrix/federation/v1/send_knock/{roomId}/{eventId}](https://spec.matrix.org/v1.1/server-server-api/#put_matrixfederationv1send_knockroomideventid)
 
 use ruma_api::ruma_api;
-use ruma_events::{room::member::RoomMemberEvent, AnyStrippedStateEvent};
+use ruma_events::AnyStrippedStateEvent;
 use ruma_identifiers::{EventId, RoomId};
+use serde_json::value::RawValue as RawJsonValue;
 
 ruma_api! {
     metadata: {
@@ -23,9 +24,9 @@ ruma_api! {
         #[ruma_api(path)]
         pub event_id: &'a EventId,
 
-        /// The full knock event.
+        /// The PDU.
         #[ruma_api(body)]
-        pub knock_event: &'a RoomMemberEvent,
+        pub pdu: &'a RawJsonValue,
     }
 
     response: {
@@ -36,12 +37,8 @@ ruma_api! {
 
 impl<'a> Request<'a> {
     /// Creates a new `Request` with the given room ID, event ID and knock event.
-    pub fn new(
-        room_id: &'a RoomId,
-        event_id: &'a EventId,
-        knock_event: &'a RoomMemberEvent,
-    ) -> Self {
-        Self { room_id, event_id, knock_event }
+    pub fn new(room_id: &'a RoomId, event_id: &'a EventId, pdu: &'a RawJsonValue) -> Self {
+        Self { room_id, event_id, pdu }
     }
 }
 
diff --git a/crates/ruma-federation-api/src/lib.rs b/crates/ruma-federation-api/src/lib.rs
index e511a079..9ebb0134 100644
--- a/crates/ruma-federation-api/src/lib.rs
+++ b/crates/ruma-federation-api/src/lib.rs
@@ -17,7 +17,6 @@ pub mod directory;
 pub mod discovery;
 pub mod event;
 pub mod keys;
-#[cfg(feature = "unstable-pre-spec")]
 pub mod knock;
 pub mod membership;
 pub mod openid;