synapse-admin-api 0.10.0

Types for the endpoints in the synapse admin API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! [POST /_synapse/admin/v1/background_updates/start_job](https://github.com/element-hq/synapse/blob/master/docs/usage/administration/admin_api/background_updates.md#run)

use ruma::{
    api::{auth_scheme::AccessToken, request, response},
    metadata,
    serde::StringEnum,
};

metadata! {
    method: POST,
    rate_limited: false,
    authentication: AccessToken,
    path: "/_synapse/admin/v1/background_updates/start_job",
}

#[request]
pub struct Request {
    /// Which job to run.
    pub job_name: JobName,
}

#[response]
#[derive(Default)]
pub struct Response {}

impl Request {
    /// Creates a `Request` with the given `job_name` value.
    pub fn new(job_name: JobName) -> Self {
        Self { job_name }
    }
}

impl Response {
    /// Creates an empty `Response`.
    pub fn new() -> Self {
        Self {}
    }
}

#[derive(Clone, StringEnum)]
#[ruma_enum(rename_all = "snake_case")]
#[non_exhaustive]
pub enum JobName {
    /// Recalculate the stats for all rooms.
    PopulateStatsProcessRooms,

    /// Recalculate the user directory if it is stale or out of sync.
    RegenerateDirectory,

    #[doc(hidden)]
    _Custom(crate::PrivOwnedStr),
}

#[test]
fn test_run_background_updates() {
    let job_name = JobName::PopulateStatsProcessRooms;
    // Check create request
    let request = Request::new(job_name.clone());
    assert_eq!(request.job_name, job_name);
}