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
//! `POST /_matrix/media/*/upload`
//!
//! Upload content to the media store.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixmediav3upload
use http::header::CONTENT_TYPE;
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedMxcUri,
};
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: true,
authentication: AccessToken,
history: {
1.0 => "/_matrix/media/r0/upload",
1.1 => "/_matrix/media/v3/upload",
}
};
/// Request type for the `create_media_content` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The name of the file being uploaded.
#[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none")]
pub filename: Option<String>,
/// The content type of the file being uploaded.
#[ruma_api(header = CONTENT_TYPE)]
pub content_type: Option<String>,
/// Should the server return a blurhash or not.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[ruma_api(query)]
#[cfg(feature = "unstable-msc2448")]
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
rename = "xyz.amorgan.generate_blurhash"
)]
pub generate_blurhash: bool,
/// The file contents to upload.
#[ruma_api(raw_body)]
pub file: Vec<u8>,
}
/// Response type for the `create_media_content` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// The MXC URI for the uploaded content.
pub content_uri: OwnedMxcUri,
/// The [BlurHash](https://blurha.sh) for the uploaded content.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(
rename = "xyz.amorgan.blurhash",
alias = "blurhash",
skip_serializing_if = "Option::is_none"
)]
pub blurhash: Option<String>,
}
impl Request {
/// Creates a new `Request` with the given file contents.
pub fn new(file: Vec<u8>) -> Self {
Self {
file,
filename: None,
content_type: None,
#[cfg(feature = "unstable-msc2448")]
generate_blurhash: false,
}
}
}
impl Response {
/// Creates a new `Response` with the given MXC URI.
pub fn new(content_uri: OwnedMxcUri) -> Self {
Self {
content_uri,
#[cfg(feature = "unstable-msc2448")]
blurhash: None,
}
}
}
}