ruma-federation-api 0.14.0

Types for the endpoints in the Matrix server-server 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
61

//! `GET /_matrix/federation/*/query/{queryType}`
//!
//! Performs a single query request on the receiving homeserver. The query arguments are dependent
//! on which type of query is being made.

pub mod v1 {
    //! `/v1/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.18/server-server-api/#get_matrixfederationv1queryquerytype

    use std::collections::BTreeMap;

    use ruma_common::{
        api::{request, response},
        metadata,
    };
    use serde_json::Value as JsonValue;

    use crate::authentication::ServerSignatures;

    metadata! {
        method: GET,
        rate_limited: false,
        authentication: ServerSignatures,
        path: "/_matrix/federation/v1/query/{query_type}",
    }

    /// Request type for the `get_custom_information` endpoint.
    #[request]
    pub struct Request {
        /// The type of query to make.
        #[ruma_api(path)]
        pub query_type: String,

        /// The query parameters.
        #[ruma_api(query_all)]
        pub params: BTreeMap<String, String>,
    }

    /// Response type for the `get_custom_information` endpoint.
    #[response]
    pub struct Response {
        /// The body of the response.
        #[ruma_api(body)]
        pub body: JsonValue,
    }

    impl Request {
        /// Creates a new request with the given type and query parameters.
        pub fn new(query_type: String, params: BTreeMap<String, String>) -> Self {
            Self { query_type, params }
        }
    }

    impl Response {
        /// Creates a new response with the given body.
        pub fn new(body: JsonValue) -> Self {
            Self { body }
        }
    }
}