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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
//! `GET /.well-known/matrix/support` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport
//!
//! Get server admin contact and support page of a homeserver's domain.
use ruma_common::{
api::{request, response, Metadata},
metadata,
serde::StringEnum,
OwnedUserId,
};
use serde::{Deserialize, Serialize};
use crate::PrivOwnedStr;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: None,
history: {
1.10 => "/.well-known/matrix/support",
}
};
/// Request type for the `discover_support` endpoint.
#[request(error = crate::Error)]
#[derive(Default)]
pub struct Request {}
/// Response type for the `discover_support` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// Ways to contact the server administrator.
///
/// At least one of `contacts` or `support_page` is required. If only `contacts` is set, it
/// must contain at least one item.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub contacts: Vec<Contact>,
/// The URL of a page to give users help specific to the homeserver, like extra
/// login/registration steps.
///
/// At least one of `contacts` or `support_page` is required.
#[serde(skip_serializing_if = "Option::is_none")]
pub support_page: Option<String>,
}
impl Request {
/// Creates an empty `Request`.
pub fn new() -> Self {
Self {}
}
}
impl Response {
/// Creates a new `Response` with the given contacts.
pub fn with_contacts(contacts: Vec<Contact>) -> Self {
Self { contacts, support_page: None }
}
/// Creates a new `Response` with the given support page.
pub fn with_support_page(support_page: String) -> Self {
Self { contacts: Vec::new(), support_page: Some(support_page) }
}
}
/// A way to contact the server administrator.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Contact {
/// An informal description of what the contact methods are used for.
pub role: ContactRole,
/// An email address to reach the administrator.
///
/// At least one of `matrix_id` or `email_address` is required.
#[serde(skip_serializing_if = "Option::is_none")]
pub email_address: Option<String>,
/// A Matrix User ID representing the administrator.
///
/// It could be an account registered on a different homeserver so the administrator can be
/// contacted when the homeserver is down.
///
/// At least one of `matrix_id` or `email_address` is required.
#[serde(skip_serializing_if = "Option::is_none")]
pub matrix_id: Option<OwnedUserId>,
}
impl Contact {
/// Creates a new `Contact` with the given role and email address.
pub fn with_email_address(role: ContactRole, email_address: String) -> Self {
Self { role, email_address: Some(email_address), matrix_id: None }
}
/// Creates a new `Contact` with the given role and Matrix User ID.
pub fn with_matrix_id(role: ContactRole, matrix_id: OwnedUserId) -> Self {
Self { role, email_address: None, matrix_id: Some(matrix_id) }
}
}
/// An informal description of what the contact methods are used for.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, StringEnum)]
#[ruma_enum(rename_all = "m.role.snake_case")]
#[non_exhaustive]
pub enum ContactRole {
/// A catch-all role for any queries.
Admin,
/// A role intended for sensitive requests.
Security,
/// A role for moderation-related queries according to [MSC4121](https://github.com/matrix-org/matrix-spec-proposals/pull/4121).
///
/// The future prefix for this if accepted will be `m.role.moderator`
#[cfg(feature = "unstable-msc4121")]
#[ruma_enum(rename = "support.feline.msc4121.role.moderator", alias = "m.role.moderator")]
Moderator,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}