chore: Add some documentation to API stuff

This commit is contained in:
timedout
2026-05-25 11:45:51 +01:00
committed by Ginger
parent 0c0ae68070
commit 688855631e
2 changed files with 5 additions and 1 deletions
@@ -29,8 +29,11 @@ pub mod v1 {
#[response]
pub struct Response {
/// Users who were successfully kicked from this room.
pub kicked_users: Vec<OwnedUserId>,
/// Users who could not be kicked from the room.
pub failed_kicked_users: Vec<OwnedUserId>,
/// Any local aliases that were removed from the room.
pub local_aliases: Vec<OwnedRoomAliasId>,
}
@@ -1,8 +1,8 @@
pub mod v1 {
use ruma::{
OwnedRoomId,
api::{auth_scheme::AccessToken, request, response},
metadata,
OwnedRoomId,
};
metadata! {
@@ -20,6 +20,7 @@ pub mod v1 {
#[response]
pub struct Response {
/// A list of room IDs known to this server.
pub rooms: Vec<OwnedRoomId>,
}