mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-27 01:23:43 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
65 lines
2 KiB
YAML
65 lines
2 KiB
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/room_event.yaml
|
|
description: This message represents a generic file.
|
|
properties:
|
|
content:
|
|
properties:
|
|
body:
|
|
description: A human-readable description of the file. This is recommended to be the filename of the original upload.
|
|
type: string
|
|
filename:
|
|
description: The original filename of the uploaded file.
|
|
type: string
|
|
info:
|
|
description: Information about the file referred to in ``url``.
|
|
properties:
|
|
mimetype:
|
|
description: The mimetype of the file e.g. ``application/msword``.
|
|
type: string
|
|
size:
|
|
description: The size of the file in bytes.
|
|
type: integer
|
|
thumbnail_url:
|
|
description: |-
|
|
The URL to the thumbnail of the file. Only present if the
|
|
thumbnail is unencrypted.
|
|
type: string
|
|
thumbnail_file:
|
|
description: |-
|
|
Information on the encrypted thumbnail file, as specified in
|
|
|encrypted_files|_. Only present if the thumbnail is encrypted.
|
|
title: EncryptedFile
|
|
type: object
|
|
thumbnail_info:
|
|
allOf:
|
|
- $ref: core-event-schema/msgtype_infos/thumbnail_info.yaml
|
|
description: Metadata about the image referred to in ``thumbnail_url``.
|
|
title: FileInfo
|
|
type: object
|
|
msgtype:
|
|
enum:
|
|
- m.file
|
|
type: string
|
|
url:
|
|
description: |-
|
|
Required if the file is unencrypted. The URL (typically `MXC URI`_)
|
|
to the file.
|
|
type: string
|
|
file:
|
|
description: |-
|
|
Required if the file is encrypted. Information on the encrypted
|
|
file, as specified in |encrypted_files|_.
|
|
title: EncryptedFile
|
|
type: object
|
|
required:
|
|
- msgtype
|
|
- body
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.room.message
|
|
type: string
|
|
title: FileMessage
|
|
type: object
|