mirror of
https://forgejo.ellis.link/continuwuation/continuwuity.git
synced 2026-05-26 20:49:55 +00:00
chore: Add some documentation to API stuff
This commit is contained in:
@@ -29,8 +29,11 @@ pub mod v1 {
|
|||||||
|
|
||||||
#[response]
|
#[response]
|
||||||
pub struct Response {
|
pub struct Response {
|
||||||
|
/// Users who were successfully kicked from this room.
|
||||||
pub kicked_users: Vec<OwnedUserId>,
|
pub kicked_users: Vec<OwnedUserId>,
|
||||||
|
/// Users who could not be kicked from the room.
|
||||||
pub failed_kicked_users: Vec<OwnedUserId>,
|
pub failed_kicked_users: Vec<OwnedUserId>,
|
||||||
|
/// Any local aliases that were removed from the room.
|
||||||
pub local_aliases: Vec<OwnedRoomAliasId>,
|
pub local_aliases: Vec<OwnedRoomAliasId>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
pub mod v1 {
|
pub mod v1 {
|
||||||
use ruma::{
|
use ruma::{
|
||||||
OwnedRoomId,
|
|
||||||
api::{auth_scheme::AccessToken, request, response},
|
api::{auth_scheme::AccessToken, request, response},
|
||||||
metadata,
|
metadata,
|
||||||
|
OwnedRoomId,
|
||||||
};
|
};
|
||||||
|
|
||||||
metadata! {
|
metadata! {
|
||||||
@@ -20,6 +20,7 @@ pub mod v1 {
|
|||||||
|
|
||||||
#[response]
|
#[response]
|
||||||
pub struct Response {
|
pub struct Response {
|
||||||
|
/// A list of room IDs known to this server.
|
||||||
pub rooms: Vec<OwnedRoomId>,
|
pub rooms: Vec<OwnedRoomId>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user