wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

"MXC URI" -> "mxc:// URI" (#1500)

Browse source 
* "MXC URI" -> "`mxc://` URI"

We're a bit inconsistent with this currently, and IMHO "`mxc://` URI" is more
explicit.

* Update content/client-server-api/modules/content_repo.md

Co-authored-by: Hubert Chathi <hubertc@matrix.org>

* more MXCs

---------

Co-authored-by: Hubert Chathi <hubertc@matrix.org>
This commit is contained in:
Richard van der Hoff 2023-04-26 14:11:35 +01:00 • committed by GitHub
parent 715f6a301d
commit 1f729eef60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 20 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -59,7 +59,7 @@ paths:
format: byte
responses:
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:
type: object
required: ["content_uri"]
@ -67,7 +67,7 @@ paths:
content_uri:
type: string
format: uri
description: "The [MXC URI](/client-server-api/#matrix-content-mxc-uris) to the uploaded content."
description: "The [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to the uploaded content."
examples:
application/json: {
"content_uri": "mxc://example.com/AQwafuaFswefuhsfAFAgsw"
@ -393,7 +393,7 @@ paths:
type: string
format: uri
description: |-
An [MXC URI](/client-server-api/#matrix-content-mxc-uris) to the image. Omitted if there is no image.
An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to the image. Omitted if there is no image.
examples:
application/json: {
"og:title": "Matrix Blog Post",

2
data/api/client-server/definitions/sso_login_flow.yaml
View file

@ -54,7 +54,7 @@ properties:
icon:
type: string
description: |-
Optional MXC URI to provide an image/icon representing the IdP.
Optional `mxc://` URI to provide an image/icon representing the IdP.
Intended to be shown alongside the `name` if provided.
example: "mxc://example.org/abc123"
brand:

2
data/api/client-server/rooms.yaml
View file

@ -297,7 +297,7 @@ paths:
avatar_url:
type: string
format: uri
description: The mxc avatar url of the user this object is representing.
description: The avatar of the user this object is representing, as an [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris).
description: A map from user ID to a RoomMember object.
type: object
403:

2
data/api/client-server/users.yaml
View file

@ -98,7 +98,7 @@ paths:
type: string
format: uri
example: "mxc://bar.com/foo"
description: The avatar url, as an MXC, if one exists.
description: The avatar url, as an [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris), if one exists.
limited:
type: boolean
description: Indicates if the result list has been truncated by the limit.

2
data/event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml
View file

@ -19,7 +19,7 @@ properties:
type: integer
thumbnail_url:
description: |-
The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
Only present if the thumbnail is unencrypted.
type: string
thumbnail_file:

2
data/event-schemas/schema/m.room.message$m.audio.yaml
View file

@ -28,7 +28,7 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
to the audio clip.
type: string
file:

2
data/event-schemas/schema/m.room.message$m.file.yaml
View file

@ -44,7 +44,7 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
to the file.
type: string
file:

2
data/event-schemas/schema/m.room.message$m.image.yaml
View file

@ -18,7 +18,7 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
to the image.
type: string
file:

4
data/event-schemas/schema/m.room.message$m.video.yaml
View file

@ -28,7 +28,7 @@ properties:
type: integer
thumbnail_url:
description: |-
The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris)) to an image thumbnail of
The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to an image thumbnail of
the video clip. Only present if the thumbnail is unencrypted.
type: string
thumbnail_file:
@ -50,7 +50,7 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
to the video clip.
type: string
file: