Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 13:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

'MXC URI' -> 'mxc:// URI'

Browse source
This commit is contained in:
Richard van der Hoff 2023-04-25 15:51:53 +01:00
parent 2ce83195a5
commit ca7487dae7
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -102,9 +102,9 @@ paths:
- Media - Media
"/_matrix/media/v3/upload/{serverName}/{mediaId}": "/_matrix/media/v3/upload/{serverName}/{mediaId}":
put: put:
summary: Upload content to an MXC URI that was created earlier. summary: Upload content to an `mxc://` URI that was created earlier.
description: |- description: |-
This endpoint permits uploading content to an MXC URI that was created This endpoint permits uploading content to an `mxc://` URI that was created
earlier via [POST /_matrix/media/v1/create](/client-server-api/#post_matrixmediav3create). earlier via [POST /_matrix/media/v1/create](/client-server-api/#post_matrixmediav3create).
operationId: uploadContentToMXC operationId: uploadContentToMXC
x-addedInMatrixVersion: "1.7" x-addedInMatrixVersion: "1.7"
@ -197,9 +197,9 @@ paths:
- Media - Media
"/_matrix/media/v1/create": "/_matrix/media/v1/create":
post: post:
summary: Create a new MXC URI without uploading the content. summary: Create a new `mxc://` URI without uploading the content.
description: |- description: |-
Creates a new MXC URI, independently of the content being uploaded. The content must be provided later Creates a new `mxc://` URI, independently of the content being uploaded. The content must be provided later
via [`PUT /_matrix/media/v3/upload/{serverName}/{mediaId}`](http://localhost:1313/client-server-api/#put_matrixmediav3uploadservernamemediaid). via [`PUT /_matrix/media/v3/upload/{serverName}/{mediaId}`](http://localhost:1313/client-server-api/#put_matrixmediav3uploadservernamemediaid).
The server may optionally enforce a maximum age for unused IDs, The server may optionally enforce a maximum age for unused IDs,
@ -211,9 +211,9 @@ paths:
to accommodate users on poor connection who find a better connection to to accommodate users on poor connection who find a better connection to
complete the upload. complete the upload.
As well as limiting the rate of requests to create MXC URIs, the server As well as limiting the rate of requests to create `mxc://` URIs, the server
should limit the number of concurrent *pending media uploads* a given should limit the number of concurrent *pending media uploads* a given
user can have. A pending media upload is a created MXC URI where (a) user can have. A pending media upload is a created `mxc://` URI where (a)
the media has not yet been uploaded, and (b) has not yet expired (the the media has not yet been uploaded, and (b) has not yet expired (the
`unused_expires_at` timestamp has not yet passed). In both cases, the `unused_expires_at` timestamp has not yet passed). In both cases, the
server should respond with an HTTP 429 error with an errcode of server should respond with an HTTP 429 error with an errcode of
@ -228,7 +228,7 @@ paths:
parameters: [] parameters: []
responses: responses:
200: 200:
description: The [MXC URI](/client-server-api/#matrix-content-mxc-uris) for the uploaded content. description: The [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) for the uploaded content.
schema: schema:
type: object type: object
required: ["content_uri"] required: ["content_uri"]
@ -237,7 +237,7 @@ paths:
type: string type: string
format: uri format: uri
description: |- description: |-
The [MXC URI](/client-server-api/#matrix-content-mxc-uris) at The [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) at
which the content will be available, once it is uploaded. which the content will be available, once it is uploaded.
example: "mxc://example.com/AQwafuaFswefuhsfAFAgsw" example: "mxc://example.com/AQwafuaFswefuhsfAFAgsw"
unused_expires_at: unused_expires_at: