ruma-client-api 0.23.1

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

//! `GET /.well-known/matrix/policy_server` ([spec])
//!
//! Gets public key information for a [Policy Server].
//!
//! Note that this endpoint is not necessarily handled by the homeserver or Policy Server. It may be
//! served by another webserver.
//!
//! [spec]: https://spec.matrix.org/v1.18/client-server-api/#getwell-knownmatrixpolicy_server
//! [Policy Server]: https://spec.matrix.org/v1.18/client-server-api/#policy-servers

use std::collections::BTreeMap;

use ruma_common::{
    SigningKeyAlgorithm,
    api::{auth_scheme::NoAccessToken, request, response},
    metadata,
    serde::Base64,
};

metadata! {
    method: GET,
    rate_limited: false,
    authentication: NoAccessToken,
    path: "/.well-known/matrix/policy_server",
}

/// Request type for the `discover_policy_server` endpoint.
#[request]
#[derive(Default)]
pub struct Request {}

/// Response type for the `discover_policy_server` endpoint.
#[response]
pub struct Response {
    /// The public keys for the Policy Server.
    ///
    /// MUST contain at least `ed25519`.
    pub public_keys: BTreeMap<SigningKeyAlgorithm, Base64>,
}

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

impl Response {
    /// Creates a new `Response` with the given ed25519 public key.
    pub fn new(ed25519_public_key: Base64) -> Self {
        Self { public_keys: [(SigningKeyAlgorithm::Ed25519, ed25519_public_key)].into() }
    }
}