client-api: Deprecate non-authenticated media endpoints
According to MSC3916 / Matrix 1.11
This commit is contained in:
parent
44b474a6f1
commit
46781d70ef
@ -16,6 +16,7 @@ Improvements:
|
|||||||
field, with a new type `SlidingSyncRoomHero`.
|
field, with a new type `SlidingSyncRoomHero`.
|
||||||
- Add support for authenticated media endpoints, according to MSC3916 / Matrix
|
- Add support for authenticated media endpoints, according to MSC3916 / Matrix
|
||||||
1.11.
|
1.11.
|
||||||
|
- They replace the newly deprecated `media::get_*` endpoints.
|
||||||
|
|
||||||
Bug fixes:
|
Bug fixes:
|
||||||
|
|
||||||
|
@ -24,11 +24,16 @@ pub mod v3 {
|
|||||||
history: {
|
history: {
|
||||||
1.0 => "/_matrix/media/r0/download/:server_name/:media_id",
|
1.0 => "/_matrix/media/r0/download/:server_name/:media_id",
|
||||||
1.1 => "/_matrix/media/v3/download/:server_name/:media_id",
|
1.1 => "/_matrix/media/v3/download/:server_name/:media_id",
|
||||||
|
1.11 => deprecated,
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Request type for the `get_media_content` endpoint.
|
/// Request type for the `get_media_content` endpoint.
|
||||||
#[request(error = crate::Error)]
|
#[request(error = crate::Error)]
|
||||||
|
#[deprecated = "\
|
||||||
|
Since Matrix 1.11, clients should use `authenticated_media::get_content::v1::Request` \
|
||||||
|
instead if the homeserver supports it.\
|
||||||
|
"]
|
||||||
pub struct Request {
|
pub struct Request {
|
||||||
/// The server name from the mxc:// URI (the authoritory component).
|
/// The server name from the mxc:// URI (the authoritory component).
|
||||||
#[ruma_api(path)]
|
#[ruma_api(path)]
|
||||||
@ -98,6 +103,7 @@ pub mod v3 {
|
|||||||
pub cross_origin_resource_policy: Option<String>,
|
pub cross_origin_resource_policy: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(deprecated)]
|
||||||
impl Request {
|
impl Request {
|
||||||
/// Creates a new `Request` with the given media ID and server name.
|
/// Creates a new `Request` with the given media ID and server name.
|
||||||
pub fn new(media_id: String, server_name: OwnedServerName) -> Self {
|
pub fn new(media_id: String, server_name: OwnedServerName) -> Self {
|
||||||
|
@ -24,11 +24,16 @@ pub mod v3 {
|
|||||||
history: {
|
history: {
|
||||||
1.0 => "/_matrix/media/r0/download/:server_name/:media_id/:filename",
|
1.0 => "/_matrix/media/r0/download/:server_name/:media_id/:filename",
|
||||||
1.1 => "/_matrix/media/v3/download/:server_name/:media_id/:filename",
|
1.1 => "/_matrix/media/v3/download/:server_name/:media_id/:filename",
|
||||||
|
1.11 => deprecated,
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Request type for the `get_media_content_as_filename` endpoint.
|
/// Request type for the `get_media_content_as_filename` endpoint.
|
||||||
#[request(error = crate::Error)]
|
#[request(error = crate::Error)]
|
||||||
|
#[deprecated = "\
|
||||||
|
Since Matrix 1.11, clients should use `authenticated_media::get_content_as_filename::v1::Request` \
|
||||||
|
instead if the homeserver supports it.\
|
||||||
|
"]
|
||||||
pub struct Request {
|
pub struct Request {
|
||||||
/// The server name from the mxc:// URI (the authoritory component).
|
/// The server name from the mxc:// URI (the authoritory component).
|
||||||
#[ruma_api(path)]
|
#[ruma_api(path)]
|
||||||
@ -102,6 +107,7 @@ pub mod v3 {
|
|||||||
pub cross_origin_resource_policy: Option<String>,
|
pub cross_origin_resource_policy: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(deprecated)]
|
||||||
impl Request {
|
impl Request {
|
||||||
/// Creates a new `Request` with the given media ID, server name and filename.
|
/// Creates a new `Request` with the given media ID, server name and filename.
|
||||||
pub fn new(media_id: String, server_name: OwnedServerName, filename: String) -> Self {
|
pub fn new(media_id: String, server_name: OwnedServerName, filename: String) -> Self {
|
||||||
|
@ -27,11 +27,16 @@ pub mod v3 {
|
|||||||
history: {
|
history: {
|
||||||
1.0 => "/_matrix/media/r0/thumbnail/:server_name/:media_id",
|
1.0 => "/_matrix/media/r0/thumbnail/:server_name/:media_id",
|
||||||
1.1 => "/_matrix/media/v3/thumbnail/:server_name/:media_id",
|
1.1 => "/_matrix/media/v3/thumbnail/:server_name/:media_id",
|
||||||
|
1.11 => deprecated,
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Request type for the `get_content_thumbnail` endpoint.
|
/// Request type for the `get_content_thumbnail` endpoint.
|
||||||
#[request(error = crate::Error)]
|
#[request(error = crate::Error)]
|
||||||
|
#[deprecated = "\
|
||||||
|
Since Matrix 1.11, clients should use `authenticated_media::get_content_thumbnail::v1::Request` \
|
||||||
|
instead if the homeserver supports it.\
|
||||||
|
"]
|
||||||
pub struct Request {
|
pub struct Request {
|
||||||
/// The server name from the mxc:// URI (the authoritory component).
|
/// The server name from the mxc:// URI (the authoritory component).
|
||||||
#[ruma_api(path)]
|
#[ruma_api(path)]
|
||||||
@ -124,6 +129,7 @@ pub mod v3 {
|
|||||||
pub cross_origin_resource_policy: Option<String>,
|
pub cross_origin_resource_policy: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(deprecated)]
|
||||||
impl Request {
|
impl Request {
|
||||||
/// Creates a new `Request` with the given media ID, server name, desired thumbnail width
|
/// Creates a new `Request` with the given media ID, server name, desired thumbnail width
|
||||||
/// and desired thumbnail height.
|
/// and desired thumbnail height.
|
||||||
|
@ -20,12 +20,17 @@ pub mod v3 {
|
|||||||
history: {
|
history: {
|
||||||
1.0 => "/_matrix/media/r0/config",
|
1.0 => "/_matrix/media/r0/config",
|
||||||
1.1 => "/_matrix/media/v3/config",
|
1.1 => "/_matrix/media/v3/config",
|
||||||
|
1.11 => deprecated,
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Request type for the `get_media_config` endpoint.
|
/// Request type for the `get_media_config` endpoint.
|
||||||
#[request(error = crate::Error)]
|
#[request(error = crate::Error)]
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
|
#[deprecated = "\
|
||||||
|
Since Matrix 1.11, clients should use `authenticated_media::get_media_config::v1::Request` \
|
||||||
|
instead if the homeserver supports it.\
|
||||||
|
"]
|
||||||
pub struct Request {}
|
pub struct Request {}
|
||||||
|
|
||||||
/// Response type for the `get_media_config` endpoint.
|
/// Response type for the `get_media_config` endpoint.
|
||||||
@ -36,6 +41,7 @@ pub mod v3 {
|
|||||||
pub upload_size: UInt,
|
pub upload_size: UInt,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(deprecated)]
|
||||||
impl Request {
|
impl Request {
|
||||||
/// Creates an empty `Request`.
|
/// Creates an empty `Request`.
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
|
@ -21,11 +21,16 @@ pub mod v3 {
|
|||||||
history: {
|
history: {
|
||||||
1.0 => "/_matrix/media/r0/preview_url",
|
1.0 => "/_matrix/media/r0/preview_url",
|
||||||
1.1 => "/_matrix/media/v3/preview_url",
|
1.1 => "/_matrix/media/v3/preview_url",
|
||||||
|
1.11 => deprecated,
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Request type for the `get_media_preview` endpoint.
|
/// Request type for the `get_media_preview` endpoint.
|
||||||
#[request(error = crate::Error)]
|
#[request(error = crate::Error)]
|
||||||
|
#[deprecated = "\
|
||||||
|
Since Matrix 1.11, clients should use `authenticated_media::get_media_preview::v1::Request` \
|
||||||
|
instead if the homeserver supports it.\
|
||||||
|
"]
|
||||||
pub struct Request {
|
pub struct Request {
|
||||||
/// URL to get a preview of.
|
/// URL to get a preview of.
|
||||||
#[ruma_api(query)]
|
#[ruma_api(query)]
|
||||||
@ -49,6 +54,7 @@ pub mod v3 {
|
|||||||
pub data: Option<Box<RawJsonValue>>,
|
pub data: Option<Box<RawJsonValue>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(deprecated)]
|
||||||
impl Request {
|
impl Request {
|
||||||
/// Creates a new `Request` with the given url.
|
/// Creates a new `Request` with the given url.
|
||||||
pub fn new(url: String) -> Self {
|
pub fn new(url: String) -> Self {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user