Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 11:34:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

C2S: Decorate old media endpoints with pointers to the new ones

Browse source 
The server-server spec might have a harder time linking to these, but that can be fixed with verbiage.
This commit is contained in:
Travis Ralston 2024-06-10 16:35:10 -06:00
parent c33390f9f8
commit 3cef6f0479
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
data/api/client-server/content-repo.yaml
View file

@ -220,6 +220,11 @@ paths:
deprecated: true deprecated: true
summary: Download content from the content repository. summary: Download content from the content repository.
description: |- description: |-
{{% boxes/note %}}
Replaced by [`GET /_matrix/client/v1/media/download/{serverName}/{mediaId}`](/client-server-api/#get_matrixclientv1mediadownloadservernamemediaid)
(requires authentication).
{{% /boxes/note %}}
{{% boxes/warning %}} {{% boxes/warning %}}
{{< changed-in v="1.11" >}} This endpoint MAY return `404 M_NOT_FOUND` {{< changed-in v="1.11" >}} This endpoint MAY return `404 M_NOT_FOUND`
for media which exists, but is after the server froze unauthenticated for media which exists, but is after the server froze unauthenticated
@ -265,6 +270,11 @@ paths:
deprecated: true deprecated: true
summary: Download content from the content repository overriding the file name summary: Download content from the content repository overriding the file name
description: |- description: |-
{{% boxes/note %}}
Replaced by [`GET /_matrix/client/v1/media/download/{serverName}/{mediaId}/{fileName}`](/client-server-api/#get_matrixclientv1mediadownloadservernamemediaidfilename)
(requires authentication).
{{% /boxes/note %}}
This will download content from the content repository (same as This will download content from the content repository (same as
the previous endpoint) but replace the target file name with the one the previous endpoint) but replace the target file name with the one
provided by the caller. provided by the caller.
@ -323,6 +333,11 @@ paths:
deprecated: true deprecated: true
summary: Download a thumbnail of content from the content repository summary: Download a thumbnail of content from the content repository
description: |- description: |-
{{% boxes/note %}}
Replaced by [`GET /_matrix/client/v1/media/thumbnail/{serverName}/{mediaId}`](/client-server-api/#get_matrixclientv1mediathumbnailservernamemediaid)
(requires authentication).
{{% /boxes/note %}}
Download a thumbnail of content from the content repository. Download a thumbnail of content from the content repository.
See the [Thumbnails](/client-server-api/#thumbnails) section for more information. See the [Thumbnails](/client-server-api/#thumbnails) section for more information.
@ -482,6 +497,10 @@ paths:
deprecated: true deprecated: true
summary: Get information about a URL for a client summary: Get information about a URL for a client
description: |- description: |-
{{% boxes/note %}}
Replaced by [`GET /_matrix/client/v1/media/preview_url`](/client-server-api/#get_matrixclientv1mediapreview_url).
{{% /boxes/note %}}
Get information about a URL for the client. Typically this is called when a Get information about a URL for the client. Typically this is called when a
client sees a URL in a message and wants to render a preview for the user. client sees a URL in a message and wants to render a preview for the user.
@ -553,6 +572,10 @@ paths:
deprecated: true deprecated: true
summary: Get the configuration for the content repository. summary: Get the configuration for the content repository.
description: |- description: |-
{{% boxes/note %}}
Replaced by [`GET /_matrix/client/v1/media/config`](/client-server-api/#get_matrixclientv1mediaconfig).
{{% /boxes/note %}}
This endpoint allows clients to retrieve the configuration of the content This endpoint allows clients to retrieve the configuration of the content
repository, such as upload limitations. repository, such as upload limitations.
Clients SHOULD use this as a guide when using content repository endpoints. Clients SHOULD use this as a guide when using content repository endpoints.