Merge pull request #338 from matrix-org/rav/yamlify_event_schemas
Convert event schemas to yamlpull/341/head
Richard van der Hoff
8 years ago
committed by
GitHub
commit
3085257d11
@ -1,31 +1,24 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Informs the room about what room aliases it has been given.",
|
||||
"description": "This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room. The ``state_key`` for this event is set to the homeserver which owns the room alias. The entire set of known aliases for the room is the union of all the ``m.room.aliases`` events, one for each homeserver. Clients **should** check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"aliases": {
|
||||
"type": "array",
|
||||
"description": "A list of room aliases.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["aliases"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "The homeserver domain which owns these room aliases."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.aliases"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: 'This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room. The ``state_key`` for this event is set to the homeserver which owns the room alias. The entire set of known aliases for the room is the union of all the ``m.room.aliases`` events, one for each homeserver. Clients **should** check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
aliases:
|
||||
description: A list of room aliases.
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- aliases
|
||||
type: object
|
||||
state_key:
|
||||
description: The homeserver domain which owns these room aliases.
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.aliases
|
||||
type: string
|
||||
title: Informs the room about what room aliases it has been given.
|
||||
type: object
|
||||
|
||||
@ -1,49 +1,38 @@
|
||||
{
|
||||
"title": "RoomAvatar",
|
||||
"description": "A picture that is associated with the room. This can be displayed alongside the room information.",
|
||||
"type": "object",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the image."
|
||||
},
|
||||
"thumbnail_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the thumbnail of the image."
|
||||
},
|
||||
"thumbnail_info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"description": "Metadata about the image referred to in ``thumbnail_url``.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
},
|
||||
"info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"description": "Metadata about the image referred to in ``url``.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
}
|
||||
},
|
||||
"required": ["url"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.avatar"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: A picture that is associated with the room. This can be displayed alongside the room information.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
description: Metadata about the image referred to in ``url``.
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
description: Metadata about the image referred to in ``thumbnail_url``.
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_url:
|
||||
description: The URL to the thumbnail of the image.
|
||||
type: string
|
||||
url:
|
||||
description: The URL to the image.
|
||||
type: string
|
||||
required:
|
||||
- url
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.avatar
|
||||
type: string
|
||||
title: RoomAvatar
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,21 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Informs the room as to which alias is the canonical one.",
|
||||
"description": "This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"alias": {
|
||||
"type": "string",
|
||||
"description": "The canonical alias."
|
||||
}
|
||||
}
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.canonical_alias"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
alias:
|
||||
description: The canonical alias.
|
||||
type: string
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.canonical_alias
|
||||
type: string
|
||||
title: Informs the room as to which alias is the canonical one.
|
||||
type: object
|
||||
|
||||
@ -1,33 +1,26 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "The first event in the room.",
|
||||
"description": "This is the first event in a room and cannot be changed. It acts as the root of all other events.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"creator": {
|
||||
"type": "string",
|
||||
"description": "The ``user_id`` of the room creator. This is set by the homeserver."
|
||||
},
|
||||
"m.federate": {
|
||||
"type": "boolean",
|
||||
"description": "Whether users on other servers can join this room. Defaults to ``true`` if key does not exist."
|
||||
}
|
||||
},
|
||||
"required": ["creator"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.create"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: This is the first event in a room and cannot be changed. It acts as the root of all other events.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
creator:
|
||||
description: The ``user_id`` of the room creator. This is set by the homeserver.
|
||||
type: string
|
||||
m.federate:
|
||||
description: Whether users on other servers can join this room. Defaults to ``true`` if key does not exist.
|
||||
type: boolean
|
||||
required:
|
||||
- creator
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.create
|
||||
type: string
|
||||
title: The first event in the room.
|
||||
type: object
|
||||
|
||||
@ -1,30 +1,26 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Controls whether guest users are allowed to join rooms.",
|
||||
"description": "This event controls whether guest users are allowed to join rooms. If this event is absent, servers should act as if it is present and has the guest_access value \"forbidden\".",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"guest_access": {
|
||||
"type": "string",
|
||||
"description": "Whether guests can join the room.",
|
||||
"enum": ["can_join", "forbidden"]
|
||||
}
|
||||
},
|
||||
"required": ["guest_access"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.guest_access"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: 'This event controls whether guest users are allowed to join rooms. If this event is absent, servers should act as if it is present and has the guest_access value "forbidden".'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
guest_access:
|
||||
description: Whether guests can join the room.
|
||||
enum:
|
||||
- can_join
|
||||
- forbidden
|
||||
type: string
|
||||
required:
|
||||
- guest_access
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.guest_access
|
||||
type: string
|
||||
title: Controls whether guest users are allowed to join rooms.
|
||||
type: object
|
||||
|
||||
@ -1,30 +1,28 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Controls visibility of history.",
|
||||
"description": "This event controls whether a user can see the events that happened in a room from before they joined.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"history_visibility": {
|
||||
"type": "string",
|
||||
"description": "Who can see the room history.",
|
||||
"enum": ["invited","joined","shared","world_readable"]
|
||||
}
|
||||
},
|
||||
"required": ["history_visibility"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.history_visibility"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: This event controls whether a user can see the events that happened in a room from before they joined.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
history_visibility:
|
||||
description: Who can see the room history.
|
||||
enum:
|
||||
- invited
|
||||
- joined
|
||||
- shared
|
||||
- world_readable
|
||||
type: string
|
||||
required:
|
||||
- history_visibility
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.history_visibility
|
||||
type: string
|
||||
title: Controls visibility of history.
|
||||
type: object
|
||||
|
||||
@ -1,30 +1,28 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Describes how users are allowed to join the room.",
|
||||
"description": "A room may be ``public`` meaning anyone can join the room without any prior action. Alternatively, it can be ``invite`` meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, ``knock`` and ``private`` are reserved keywords which are not implemented.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"join_rule": {
|
||||
"type": "string",
|
||||
"description": "The type of rules used for users wishing to join this room.",
|
||||
"enum": ["public","knock","invite","private"]
|
||||
}
|
||||
},
|
||||
"required": ["join_rule"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.join_rules"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: 'A room may be ``public`` meaning anyone can join the room without any prior action. Alternatively, it can be ``invite`` meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, ``knock`` and ``private`` are reserved keywords which are not implemented.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
join_rule:
|
||||
description: The type of rules used for users wishing to join this room.
|
||||
enum:
|
||||
- public
|
||||
- knock
|
||||
- invite
|
||||
- private
|
||||
type: string
|
||||
required:
|
||||
- join_rule
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.join_rules
|
||||
type: string
|
||||
title: Describes how users are allowed to join the room.
|
||||
type: object
|
||||
|
||||
@ -1,95 +1,105 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "The current membership state of a user in the room.",
|
||||
"description": "Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (``/rooms/<room id>/invite`` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail. \n\nThe following membership states are specified:\n\n- ``invite`` - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.\n\n- ``join`` - The user has joined the room (possibly after accepting an invite), and may participate in it.\n\n- ``leave`` - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).\n\n- ``ban`` - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ``ban``).\n\n- ``knock`` - This is a reserved word, which currently has no meaning.\n\nThe ``third_party_invite`` property will be set if this invite is an ``invite`` event and is the successor of an ``m.room.third_party_invite`` event, and absent otherwise.\n\nThis event may also include an ``invite_room_state`` key **outside the** ``content`` **key**. If present, this contains an array of ``StrippedState`` Events. These events provide information on a subset of state events such as the room name.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"title": "EventContent",
|
||||
"properties": {
|
||||
"membership": {
|
||||
"type": "string",
|
||||
"description": "The membership state of the user.",
|
||||
"enum": ["invite","join","knock","leave","ban"]
|
||||
},
|
||||
"avatar_url": {
|
||||
"type": "string",
|
||||
"description": "The avatar URL for this user, if any. This is added by the homeserver."
|
||||
},
|
||||
"displayname": {
|
||||
"type": ["string", "null"],
|
||||
"description": "The display name for this user, if any. This is added by the homeserver."
|
||||
},
|
||||
"third_party_invite": {
|
||||
"type": "object",
|
||||
"title": "Invite",
|
||||
"properties": {
|
||||
"display_name": {
|
||||
"type": "string",
|
||||
"description": "A name which can be displayed to represent the user instead of their third party identifier"
|
||||
},
|
||||
"signed": {
|
||||
"type": "object",
|
||||
"title": "signed",
|
||||
"description": "A block of content which has been signed, which servers can use to verify the event. Clients should ignore this.",
|
||||
"properties": {
|
||||
"mxid": {
|
||||
"type": "string",
|
||||
"description": "The invited matrix user ID. Must be equal to the user_id property of the event."
|
||||
},
|
||||
"token": {
|
||||
"type": "string",
|
||||
"description": "The token property of the containing third_party_invite object."
|
||||
},
|
||||
"signatures": {
|
||||
"type": "object",
|
||||
"description": "A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.",
|
||||
"title": "Signatures"
|
||||
}
|
||||
},
|
||||
"required": ["mxid", "signatures", "token"]
|
||||
}
|
||||
},
|
||||
"required": ["display_name", "signed"]
|
||||
}
|
||||
},
|
||||
"required": ["membership"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "The ``user_id`` this membership event relates to."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.member"]
|
||||
},
|
||||
"invite_room_state": {
|
||||
"type": "array",
|
||||
"description": "A subset of the state of the room at the time of the invite, if ``membership`` is ``invite``. Note that this state is informational, and SHOULD NOT be trusted; once the client has joined the room, it SHOULD fetch the live state from the server and discard the invite_room_state. Also, clients must not rely on any particular state being present here; they SHOULD behave properly (with possibly a degraded but not a broken experience) in the absence of any particular events here. If they are set on the room, at least the state for ``m.room.avatar``, ``m.room.canonical_alias``, ``m.room.join_rules``, and ``m.room.name`` SHOULD be included.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"title": "StrippedState",
|
||||
"description": "A stripped down state event, with only the ``type``, ``state_key`` and ``content`` keys.",
|
||||
"required": ["type", "state_key", "content"],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "The ``type`` for the event."
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "The ``state_key`` for the event."
|
||||
},
|
||||
"content": {
|
||||
"title": "EventContent",
|
||||
"type": "object",
|
||||
"description": "The ``content`` for the event."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: |-
|
||||
Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (``/rooms/<room id>/invite`` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail.
|
||||
|
||||
The following membership states are specified:
|
||||
|
||||
- ``invite`` - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.
|
||||
|
||||
- ``join`` - The user has joined the room (possibly after accepting an invite), and may participate in it.
|
||||
|
||||
- ``leave`` - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).
|
||||
|
||||
- ``ban`` - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ``ban``).
|
||||
|
||||
- ``knock`` - This is a reserved word, which currently has no meaning.
|
||||
|
||||
The ``third_party_invite`` property will be set if this invite is an ``invite`` event and is the successor of an ``m.room.third_party_invite`` event, and absent otherwise.
|
||||
|
||||
This event may also include an ``invite_room_state`` key **outside the** ``content`` **key**. If present, this contains an array of ``StrippedState`` Events. These events provide information on a subset of state events such as the room name.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
avatar_url:
|
||||
description: 'The avatar URL for this user, if any. This is added by the homeserver.'
|
||||
type: string
|
||||
displayname:
|
||||
description: 'The display name for this user, if any. This is added by the homeserver.'
|
||||
type:
|
||||
- "string"
|
||||
- "null"
|
||||
membership:
|
||||
description: The membership state of the user.
|
||||
enum:
|
||||
- invite
|
||||
- join
|
||||
- knock
|
||||
- leave
|
||||
- ban
|
||||
type: string
|
||||
third_party_invite:
|
||||
properties:
|
||||
display_name:
|
||||
description: A name which can be displayed to represent the user instead of their third party identifier
|
||||
type: string
|
||||
signed:
|
||||
description: 'A block of content which has been signed, which servers can use to verify the event. Clients should ignore this.'
|
||||
properties:
|
||||
mxid:
|
||||
description: The invited matrix user ID. Must be equal to the user_id property of the event.
|
||||
type: string
|
||||
signatures:
|
||||
description: 'A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.'
|
||||
title: Signatures
|
||||
type: object
|
||||
token:
|
||||
description: The token property of the containing third_party_invite object.
|
||||
type: string
|
||||
required:
|
||||
- mxid
|
||||
- signatures
|
||||
- token
|
||||
title: signed
|
||||
type: object
|
||||
required:
|
||||
- display_name
|
||||
- signed
|
||||
title: Invite
|
||||
type: object
|
||||
required:
|
||||
- membership
|
||||
title: EventContent
|
||||
type: object
|
||||
invite_room_state:
|
||||
description: 'A subset of the state of the room at the time of the invite, if ``membership`` is ``invite``. Note that this state is informational, and SHOULD NOT be trusted; once the client has joined the room, it SHOULD fetch the live state from the server and discard the invite_room_state. Also, clients must not rely on any particular state being present here; they SHOULD behave properly (with possibly a degraded but not a broken experience) in the absence of any particular events here. If they are set on the room, at least the state for ``m.room.avatar``, ``m.room.canonical_alias``, ``m.room.join_rules``, and ``m.room.name`` SHOULD be included.'
|
||||
items:
|
||||
description: 'A stripped down state event, with only the ``type``, ``state_key`` and ``content`` keys.'
|
||||
properties:
|
||||
content:
|
||||
description: The ``content`` for the event.
|
||||
title: EventContent
|
||||
type: object
|
||||
state_key:
|
||||
description: The ``state_key`` for the event.
|
||||
type: string
|
||||
type:
|
||||
description: The ``type`` for the event.
|
||||
type: string
|
||||
required:
|
||||
- type
|
||||
- state_key
|
||||
- content
|
||||
title: StrippedState
|
||||
type: object
|
||||
type: array
|
||||
state_key:
|
||||
description: The ``user_id`` this membership event relates to.
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.member
|
||||
type: string
|
||||
title: The current membership state of a user in the room.
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,23 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Message",
|
||||
"description": "This event is used when sending messages in a room. Messages are not limited to be text. The ``msgtype`` key outlines the type of message, e.g. text, audio, image, video, etc. The ``body`` key is text and MUST be used with every kind of ``msgtype`` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"description": "The type of message, e.g. ``m.image``, ``m.text``"
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "The textual representation of this message."
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: 'This event is used when sending messages in a room. Messages are not limited to be text. The ``msgtype`` key outlines the type of message, e.g. text, audio, image, video, etc. The ``body`` key is text and MUST be used with every kind of ``msgtype`` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: The textual representation of this message.
|
||||
type: string
|
||||
msgtype:
|
||||
description: 'The type of message, e.g. ``m.image``, ``m.text``'
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: Message
|
||||
type: object
|
||||
|
||||
@ -1,51 +1,42 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "AudioMessage",
|
||||
"description": "This message represents a single audio clip.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.audio"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "A description of the audio e.g. 'Bee Gees - Stayin' Alive', or some kind of content description for accessibility e.g. 'audio attachment'."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the audio clip."
|
||||
},
|
||||
"info": {
|
||||
"type": "object",
|
||||
"title": "AudioInfo",
|
||||
"description": "Metadata for the audio clip referred to in ``url``.",
|
||||
"properties": {
|
||||
"mimetype": {
|
||||
"type": "string",
|
||||
"description": "The mimetype of the audio e.g. ``audio/aac``."
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"description": "The size of the audio clip in bytes."
|
||||
},
|
||||
"duration": {
|
||||
"type": "integer",
|
||||
"description": "The duration of the audio in milliseconds."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body", "url"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: This message represents a single audio clip.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: "A description of the audio e.g. 'Bee Gees - Stayin' Alive', or some kind of content description for accessibility e.g. 'audio attachment'."
|
||||
type: string
|
||||
info:
|
||||
description: Metadata for the audio clip referred to in ``url``.
|
||||
properties:
|
||||
duration:
|
||||
description: The duration of the audio in milliseconds.
|
||||
type: integer
|
||||
mimetype:
|
||||
description: The mimetype of the audio e.g. ``audio/aac``.
|
||||
type: string
|
||||
size:
|
||||
description: The size of the audio clip in bytes.
|
||||
type: integer
|
||||
title: AudioInfo
|
||||
type: object
|
||||
msgtype:
|
||||
enum:
|
||||
- m.audio
|
||||
type: string
|
||||
url:
|
||||
description: The URL to the audio clip.
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
- url
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: AudioMessage
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,24 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "EmoteMessage",
|
||||
"description": "This message is similar to ``m.text`` except that the sender is 'performing' the action contained in the ``body`` key, similar to ``/me`` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular ``m.text`` messages.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.emote"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "The emote action to perform."
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: "This message is similar to ``m.text`` except that the sender is 'performing' the action contained in the ``body`` key, similar to ``/me`` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular ``m.text`` messages."
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: The emote action to perform.
|
||||
type: string
|
||||
msgtype:
|
||||
enum:
|
||||
- m.emote
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: EmoteMessage
|
||||
type: object
|
||||
|
||||
@ -1,63 +1,52 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "FileMessage",
|
||||
"description": "This message represents a generic file.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.file"]
|
||||
},
|
||||
"filename": {
|
||||
"type": "string",
|
||||
"description": "The original filename of the uploaded file."
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "A human-readable description of the file. This is recommended to be the filename of the original upload."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the file."
|
||||
},
|
||||
"info": {
|
||||
"type": "object",
|
||||
"title": "FileInfo",
|
||||
"description": "Information about the file referred to in ``url``.",
|
||||
"properties": {
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"description": "The size of the file in bytes."
|
||||
},
|
||||
"mimetype": {
|
||||
"type": "string",
|
||||
"description": "The mimetype of the file e.g. ``application/msword``."
|
||||
}
|
||||
}
|
||||
},
|
||||
"thumbnail_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the thumbnail of the file."
|
||||
},
|
||||
"thumbnail_info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"description": "Metadata about the image referred to in ``thumbnail_url``.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body", "url", "filename"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
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
|
||||
title: FileInfo
|
||||
type: object
|
||||
msgtype:
|
||||
enum:
|
||||
- m.file
|
||||
type: string
|
||||
thumbnail_info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
description: Metadata about the image referred to in ``thumbnail_url``.
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_url:
|
||||
description: The URL to the thumbnail of the file.
|
||||
type: string
|
||||
url:
|
||||
description: The URL to the file.
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
- url
|
||||
- filename
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: FileMessage
|
||||
type: object
|
||||
|
||||
@ -1,67 +1,54 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "ImageMessage",
|
||||
"description": "This message represents a single image and an optional thumbnail.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.image"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "A textual representation of the image. This could be the alt text of the image, the filename of the image, or some kind of content description for accessibility e.g. 'image attachment'."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the image."
|
||||
},
|
||||
"thumbnail_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the thumbnail of the image."
|
||||
},
|
||||
"thumbnail_info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"description": "Metadata about the image referred to in ``thumbnail_url``.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
},
|
||||
"info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"description": "Metadata about the image referred to in ``url``.",
|
||||
"properties": {
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"description": "Size of the image in bytes."
|
||||
},
|
||||
"w": {
|
||||
"type": "integer",
|
||||
"description": "The width of the image in pixels."
|
||||
},
|
||||
"h": {
|
||||
"type": "integer",
|
||||
"description": "The height of the image in pixels."
|
||||
},
|
||||
"mimetype": {
|
||||
"type": "string",
|
||||
"description": "The mimetype of the image, e.g. ``image/jpeg``."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body", "url"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: This message represents a single image and an optional thumbnail.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: "A textual representation of the image. This could be the alt text of the image, the filename of the image, or some kind of content description for accessibility e.g. 'image attachment'."
|
||||
type: string
|
||||
info:
|
||||
description: Metadata about the image referred to in ``url``.
|
||||
properties:
|
||||
h:
|
||||
description: The height of the image in pixels.
|
||||
type: integer
|
||||
mimetype:
|
||||
description: 'The mimetype of the image, e.g. ``image/jpeg``.'
|
||||
type: string
|
||||
size:
|
||||
description: Size of the image in bytes.
|
||||
type: integer
|
||||
w:
|
||||
description: The width of the image in pixels.
|
||||
type: integer
|
||||
title: ImageInfo
|
||||
type: object
|
||||
msgtype:
|
||||
enum:
|
||||
- m.image
|
||||
type: string
|
||||
thumbnail_info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
description: Metadata about the image referred to in ``thumbnail_url``.
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_url:
|
||||
description: The URL to the thumbnail of the image.
|
||||
type: string
|
||||
url:
|
||||
description: The URL to the image.
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
- url
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: ImageMessage
|
||||
type: object
|
||||
|
||||
@ -1,43 +1,36 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "LocationMessage",
|
||||
"description": "This message represents a real-world location.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.location"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "A description of the location e.g. 'Big Ben, London, UK', or some kind of content description for accessibility e.g. 'location attachment'."
|
||||
},
|
||||
"geo_uri": {
|
||||
"type": "string",
|
||||
"description": "A geo URI representing this location."
|
||||
},
|
||||
"thumbnail_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to a thumbnail of the location being represented."
|
||||
},
|
||||
"thumbnail_info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body", "geo_uri"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: This message represents a real-world location.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: "A description of the location e.g. 'Big Ben, London, UK', or some kind of content description for accessibility e.g. 'location attachment'."
|
||||
type: string
|
||||
geo_uri:
|
||||
description: A geo URI representing this location.
|
||||
type: string
|
||||
msgtype:
|
||||
enum:
|
||||
- m.location
|
||||
type: string
|
||||
thumbnail_info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_url:
|
||||
description: The URL to a thumbnail of the location being represented.
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
- geo_uri
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: LocationMessage
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,24 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "NoticeMessage",
|
||||
"description": "A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.notice"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "The notice text to send."
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: 'A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: The notice text to send.
|
||||
type: string
|
||||
msgtype:
|
||||
enum:
|
||||
- m.notice
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: NoticeMessage
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,24 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "TextMessage",
|
||||
"description": "This message is the most basic message and is used to represent text.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.text"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "The body of the message."
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: This message is the most basic message and is used to represent text.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: The body of the message.
|
||||
type: string
|
||||
msgtype:
|
||||
enum:
|
||||
- m.text
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: TextMessage
|
||||
type: object
|
||||
|
||||
@ -1,70 +1,56 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "VideoMessage",
|
||||
"description": "This message represents a single video clip.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"msgtype": {
|
||||
"type": "string",
|
||||
"enum": ["m.video"]
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "A description of the video e.g. 'Gangnam style', or some kind of content description for accessibility e.g. 'video attachment'."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL to the video clip."
|
||||
},
|
||||
"info": {
|
||||
"type": "object",
|
||||
"title": "VideoInfo",
|
||||
"description": "Metadata about the video clip referred to in ``url``.",
|
||||
"properties": {
|
||||
"mimetype": {
|
||||
"type": "string",
|
||||
"description": "The mimetype of the video e.g. ``video/mp4``."
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"description": "The size of the video in bytes."
|
||||
},
|
||||
"duration": {
|
||||
"type": "integer",
|
||||
"description": "The duration of the video in milliseconds."
|
||||
},
|
||||
"w": {
|
||||
"type": "integer",
|
||||
"description": "The width of the video in pixels."
|
||||
},
|
||||
"h": {
|
||||
"type": "integer",
|
||||
"description": "The height of the video in pixels."
|
||||
},
|
||||
"thumbnail_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to a thumbnail of the video clip."
|
||||
},
|
||||
"thumbnail_info": {
|
||||
"type": "object",
|
||||
"title": "ImageInfo",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/msgtype_infos/image_info.yaml"
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["msgtype", "body", "url"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: This message represents a single video clip.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
body:
|
||||
description: "A description of the video e.g. 'Gangnam style', or some kind of content description for accessibility e.g. 'video attachment'."
|
||||
type: string
|
||||
info:
|
||||
description: Metadata about the video clip referred to in ``url``.
|
||||
properties:
|
||||
duration:
|
||||
description: The duration of the video in milliseconds.
|
||||
type: integer
|
||||
h:
|
||||
description: The height of the video in pixels.
|
||||
type: integer
|
||||
mimetype:
|
||||
description: The mimetype of the video e.g. ``video/mp4``.
|
||||
type: string
|
||||
size:
|
||||
description: The size of the video in bytes.
|
||||
type: integer
|
||||
thumbnail_info:
|
||||
allOf:
|
||||
- $ref: core-event-schema/msgtype_infos/image_info.yaml
|
||||
title: ImageInfo
|
||||
type: object
|
||||
thumbnail_url:
|
||||
description: The URL to a thumbnail of the video clip.
|
||||
type: string
|
||||
w:
|
||||
description: The width of the video in pixels.
|
||||
type: integer
|
||||
title: VideoInfo
|
||||
type: object
|
||||
msgtype:
|
||||
enum:
|
||||
- m.video
|
||||
type: string
|
||||
url:
|
||||
description: The URL to the video clip.
|
||||
type: string
|
||||
required:
|
||||
- msgtype
|
||||
- body
|
||||
- url
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message
|
||||
type: string
|
||||
title: VideoMessage
|
||||
type: object
|
||||
|
||||
@ -1,29 +1,26 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "MessageFeedback",
|
||||
"description": "**NB: Usage of this event is discouraged in favour of the** `receipts module`_. **Most clients will not recognise this event.** Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: ``delivered`` (sent when the event has been received) and ``read`` (sent when the event has been observed by the end-user). The ``target_event_id`` should reference the ``m.room.message`` event being acknowledged.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "The type of feedback.",
|
||||
"enum": ["delivered", "read"]
|
||||
},
|
||||
"target_event_id": {
|
||||
"type": "string",
|
||||
"description": "The event that this feedback is related to."
|
||||
}
|
||||
},
|
||||
"required": ["type", "target_event_id"]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.message.feedback"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: '**NB: Usage of this event is discouraged in favour of the** `receipts module`_. **Most clients will not recognise this event.** Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: ``delivered`` (sent when the event has been received) and ``read`` (sent when the event has been observed by the end-user). The ``target_event_id`` should reference the ``m.room.message`` event being acknowledged.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
target_event_id:
|
||||
description: The event that this feedback is related to.
|
||||
type: string
|
||||
type:
|
||||
description: The type of feedback.
|
||||
enum:
|
||||
- delivered
|
||||
- read
|
||||
type: string
|
||||
required:
|
||||
- type
|
||||
- target_event_id
|
||||
type: object
|
||||
type:
|
||||
enum:
|
||||
- m.room.message.feedback
|
||||
type: string
|
||||
title: MessageFeedback
|
||||
type: object
|
||||
|
||||
@ -1,29 +1,23 @@
|
||||
{
|
||||
"title": "RoomName",
|
||||
"description": "A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using ``/createRoom`` with the ``name`` key.",
|
||||
"type": "object",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the room. This MUST NOT exceed 255 bytes."
|
||||
}
|
||||
},
|
||||
"required": ["name"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.name"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: 'A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using ``/createRoom`` with the ``name`` key.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
name:
|
||||
description: The name of the room. This MUST NOT exceed 255 bytes.
|
||||
type: string
|
||||
required:
|
||||
- name
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.name
|
||||
type: string
|
||||
title: RoomName
|
||||
type: object
|
||||
|
||||
@ -1,70 +1,75 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Defines the power levels (privileges) of users in the room.",
|
||||
"description": "This event specifies the minimum level a user must have in order to perform a certain action. It also specifies the levels of each user in the room.\n\nIf a ``user_id`` is in the ``users`` list, then that ``user_id`` has the associated power level. Otherwise they have the default level ``users_default``. If ``users_default`` is not supplied, it is assumed to be 0.\n\nThe level required to send a certain event is governed by ``events``, ``state_default`` and ``events_default``. If an event type is specified in ``events``, then the user must have at least the level specified in order to send that event. If the event type is not supplied, it defaults to ``events_default`` for Message Events and ``state_default`` for State Events. If there is no ``state_default`` in the ``power_levels`` event, the ``state_default`` is 50. If the room contains no ``power_levels`` event, the ``state_default`` is 0. The ``events_default`` is 0 in either of these cases.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ban": {
|
||||
"type": "number",
|
||||
"description": "The level required to ban a user."
|
||||
},
|
||||
"events_default": {
|
||||
"type": "number",
|
||||
"description": "The default level required to send message events. Can be overridden by the ``events`` key."
|
||||
},
|
||||
"kick": {
|
||||
"type": "number",
|
||||
"description": "The level required to kick a user."
|
||||
},
|
||||
"redact": {
|
||||
"type": "number",
|
||||
"description": "The level required to redact an event."
|
||||
},
|
||||
"invite": {
|
||||
"type": "number",
|
||||
"description": "The level required to invite a user."
|
||||
},
|
||||
"state_default": {
|
||||
"type": "number",
|
||||
"description": "The default level required to send state events. Can be overridden by the ``events`` key."
|
||||
},
|
||||
"users_default": {
|
||||
"type": "number",
|
||||
"description": "The default power level for every user in the room, unless their ``user_id`` is mentioned in the ``users`` key."
|
||||
},
|
||||
"events": {
|
||||
"type": "object",
|
||||
"title": "Event power levels",
|
||||
"description": "The level required to send specific event types. This is a mapping from event type to power level required.",
|
||||
"additionalProperties": {
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"users": {
|
||||
"type": "object",
|
||||
"title": "User power levels",
|
||||
"description": "The power levels for specific users. This is a mapping from ``user_id`` to power level for that user.",
|
||||
"additionalProperties": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["ban","events","events_default","kick","redact",
|
||||
"state_default","users"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.power_levels"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: |-
|
||||
This event specifies the minimum level a user must have in order to perform a
|
||||
certain action. It also specifies the levels of each user in the room.
|
||||
|
||||
If a ``user_id`` is in the ``users`` list, then that ``user_id`` has the
|
||||
associated power level. Otherwise they have the default level
|
||||
``users_default``. If ``users_default`` is not supplied, it is assumed to be
|
||||
0.
|
||||
|
||||
The level required to send a certain event is governed by ``events``,
|
||||
``state_default`` and ``events_default``. If an event type is specified in
|
||||
``events``, then the user must have at least the level specified in order to
|
||||
send that event. If the event type is not supplied, it defaults to
|
||||
``events_default`` for Message Events and ``state_default`` for State
|
||||
Events. If there is no ``state_default`` in the ``power_levels`` event, the
|
||||
``state_default`` is 50. If the room contains no ``power_levels`` event, the
|
||||
``state_default`` is 0. The ``events_default`` is 0 in either of these cases.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
ban:
|
||||
description: The level required to ban a user.
|
||||
type: number
|
||||
events:
|
||||
additionalProperties:
|
||||
type: number
|
||||
description: The level required to send specific event types. This is a mapping from event type to power level required.
|
||||
title: Event power levels
|
||||
type: object
|
||||
events_default:
|
||||
description: The default level required to send message events. Can be overridden by the ``events`` key.
|
||||
type: number
|
||||
invite:
|
||||
description: The level required to invite a user.
|
||||
type: number
|
||||
kick:
|
||||
description: The level required to kick a user.
|
||||
type: number
|
||||
redact:
|
||||
description: The level required to redact an event.
|
||||
type: number
|
||||
state_default:
|
||||
description: The default level required to send state events. Can be overridden by the ``events`` key.
|
||||
type: number
|
||||
users:
|
||||
additionalProperties:
|
||||
type: number
|
||||
description: The power levels for specific users. This is a mapping from ``user_id`` to power level for that user.
|
||||
title: User power levels
|
||||
type: object
|
||||
users_default:
|
||||
description: 'The default power level for every user in the room, unless their ``user_id`` is mentioned in the ``users`` key.'
|
||||
type: number
|
||||
required:
|
||||
- ban
|
||||
- events
|
||||
- events_default
|
||||
- kick
|
||||
- redact
|
||||
- state_default
|
||||
- users
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.power_levels
|
||||
type: string
|
||||
title: Defines the power levels (privileges) of users in the room.
|
||||
type: object
|
||||
|
||||
@ -1,28 +1,22 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Redaction",
|
||||
"description": "Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the ``redacts`` event level key.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/room_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "The reason for the redaction, if any."
|
||||
}
|
||||
}
|
||||
},
|
||||
"redacts": {
|
||||
"type": "string",
|
||||
"description": "The event ID that was redacted."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.redaction"]
|
||||
}
|
||||
},
|
||||
"required": ["redacts"]
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/room_event.yaml
|
||||
description: 'Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the ``redacts`` event level key.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
reason:
|
||||
description: 'The reason for the redaction, if any.'
|
||||
type: string
|
||||
type: object
|
||||
redacts:
|
||||
description: The event ID that was redacted.
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.redaction
|
||||
type: string
|
||||
required:
|
||||
- redacts
|
||||
title: Redaction
|
||||
type: object
|
||||
|
||||
@ -1,56 +1,46 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"type": "object",
|
||||
"title": "An invitation to a room issued to a third party identifier, rather than a matrix user ID.",
|
||||
"description": "Acts as an ``m.room.member`` invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"display_name": {
|
||||
"type": "string",
|
||||
"description": "A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID."
|
||||
},
|
||||
"key_validity_url": {
|
||||
"type": "string",
|
||||
"description": "A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named 'valid'."
|
||||
},
|
||||
"public_key": {
|
||||
"type": "string",
|
||||
"description": "A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility."
|
||||
},
|
||||
"public_keys": {
|
||||
"type": "array",
|
||||
"description": "Keys with which the token may be signed.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"title": "PublicKeys",
|
||||
"properties": {
|
||||
"public_key": {
|
||||
"type": "string",
|
||||
"description": "A base-64 encoded ed25519 key with which token may be signed."
|
||||
},
|
||||
"key_validity_url": {
|
||||
"type": "string",
|
||||
"description": "An optional URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named 'valid'. If this URL is absent, the key must be considered valid indefinitely."
|
||||
}
|
||||
},
|
||||
"required": ["public_key"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["display_name", "key_validity_url", "public_key"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "The token, of which a signature must be produced in order to join the room."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.third_party_invite"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
$schema: http://json-schema.org/draft-04/schema#
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: "Acts as an ``m.room.member`` invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room."
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
display_name:
|
||||
description: "A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID."
|
||||
type: string
|
||||
key_validity_url:
|
||||
description: "A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named 'valid'."
|
||||
type: string
|
||||
public_key:
|
||||
description: A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.
|
||||
type: string
|
||||
public_keys:
|
||||
description: Keys with which the token may be signed.
|
||||
items:
|
||||
properties:
|
||||
key_validity_url:
|
||||
description: "An optional URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named 'valid'. If this URL is absent, the key must be considered valid indefinitely."
|
||||
type: string
|
||||
public_key:
|
||||
description: A base-64 encoded ed25519 key with which token may be signed.
|
||||
type: string
|
||||
required:
|
||||
- public_key
|
||||
title: PublicKeys
|
||||
type: object
|
||||
type: array
|
||||
required:
|
||||
- display_name
|
||||
- key_validity_url
|
||||
- public_key
|
||||
type: object
|
||||
state_key:
|
||||
description: 'The token, of which a signature must be produced in order to join the room.'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.third_party_invite
|
||||
type: string
|
||||
title: 'An invitation to a room issued to a third party identifier, rather than a matrix user ID.'
|
||||
type: object
|
||||
|
||||
@ -1,29 +1,23 @@
|
||||
{
|
||||
"type": "object",
|
||||
"title": "Topic",
|
||||
"description": "A topic is a short message detailing what is currently being discussed in the room. It can also be used as a way to display extra information about the room, which may not be suitable for the room name. The room topic can also be set when creating a room using ``/createRoom`` with the ``topic`` key.",
|
||||
"allOf": [{
|
||||
"$ref": "core-event-schema/state_event.yaml"
|
||||
}],
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"topic": {
|
||||
"type": "string",
|
||||
"description": "The topic text."
|
||||
}
|
||||
},
|
||||
"required": ["topic"]
|
||||
},
|
||||
"state_key": {
|
||||
"type": "string",
|
||||
"description": "A zero-length string.",
|
||||
"pattern": "^$"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": ["m.room.topic"]
|
||||
}
|
||||
}
|
||||
}
|
||||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: 'A topic is a short message detailing what is currently being discussed in the room. It can also be used as a way to display extra information about the room, which may not be suitable for the room name. The room topic can also be set when creating a room using ``/createRoom`` with the ``topic`` key.'
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
topic:
|
||||
description: The topic text.
|
||||
type: string
|
||||
required:
|
||||
- topic
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.topic
|
||||
type: string
|
||||
title: Topic
|
||||
type: object
|
||||
|
||||
Loading…
Reference in New Issue