ruma_federation_api/discovery/
get_server_version.rs

Help
1//! `GET /_matrix/federation/*/version`
2//!
3//! Get the implementation name and version of this homeserver.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1version
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13    };
14    use serde::{Deserialize, Serialize};
15
16    const METADATA: Metadata = metadata! {
17        method: GET,
18        rate_limited: false,
19        authentication: None,
20        history: {
21            1.0 => "/_matrix/federation/v1/version",
22        }
23    };
24
25    /// Request type for the `get_server_version` endpoint.
26    #[request]
27    #[derive(Default)]
28    pub struct Request {}
29
30    /// Response type for the `get_server_version` endpoint.
31    #[response]
32    #[derive(Default)]
33    pub struct Response {
34        /// Information about the homeserver implementation
35        #[serde(skip_serializing_if = "Option::is_none")]
36        pub server: Option<Server>,
37    }
38
39    impl Request {
40        /// Creates an empty `Request`.
41        pub fn new() -> Self {
42            Self {}
43        }
44    }
45
46    impl Response {
47        /// Creates an empty `Response`.
48        pub fn new() -> Self {
49            Default::default()
50        }
51    }
52
53    /// Arbitrary values that identify this implementation.
54    #[derive(Clone, Debug, Default, Serialize, Deserialize)]
55    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
56    pub struct Server {
57        /// Arbitrary name that identifies this implementation.
58        #[serde(skip_serializing_if = "Option::is_none")]
59        pub name: Option<String>,
60
61        /// Version of this implementation.
62        ///
63        /// The version format depends on the implementation.
64        #[serde(skip_serializing_if = "Option::is_none")]
65        pub version: Option<String>,
66    }
67
68    impl Server {
69        /// Creates an empty `Server`.
70        pub fn new() -> Self {
71            Default::default()
72        }
73    }
74}
ruma_federation_api/discovery/get_server_version.rs

ruma_federation_api/discovery/
get_server_version.rs
