mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-01 14:44:09 +02:00
Compare commits
1 commit
fa26eaab26
...
1effa3ba0e
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1effa3ba0e |
|
|
@ -1 +1 @@
|
||||||
Fix various typos throughout the specification. Contributed by @HarHarLinks.
|
Fix typos, formatting, wording. Contributed by @HarHarLinks.
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
Fix various typos throughout the specification. Contributed by @HarHarLinks.
|
Fix typos, formatting, wording. Contributed by @HarHarLinks.
|
||||||
|
|
|
||||||
|
|
@ -23,14 +23,14 @@ properties:
|
||||||
not_senders:
|
not_senders:
|
||||||
description: A list of sender IDs to exclude. If this list is absent then no senders
|
description: A list of sender IDs to exclude. If this list is absent then no senders
|
||||||
are excluded. A matching sender will be excluded even if it is listed in the
|
are excluded. A matching sender will be excluded even if it is listed in the
|
||||||
`senders` filter.
|
`'senders'` filter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
not_types:
|
not_types:
|
||||||
description: A list of event types to exclude. If this list is absent then no
|
description: A list of event types to exclude. If this list is absent then no
|
||||||
event types are excluded. A matching type will be excluded even if it is listed
|
event types are excluded. A matching type will be excluded even if it is listed
|
||||||
in the `types` filter. A `*` can be used as a wildcard to match any sequence
|
in the `'types'` filter. A '*' can be used as a wildcard to match any sequence
|
||||||
of characters.
|
of characters.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|
@ -43,7 +43,7 @@ properties:
|
||||||
type: array
|
type: array
|
||||||
types:
|
types:
|
||||||
description: A list of event types to include. If this list is absent then all
|
description: A list of event types to include. If this list is absent then all
|
||||||
event types are included. A `*` can be used as a wildcard to match any sequence
|
event types are included. A `'*'` can be used as a wildcard to match any sequence
|
||||||
of characters.
|
of characters.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -39,7 +39,7 @@ allOf:
|
||||||
for more information. Defaults to `false`.
|
for more information. Defaults to `false`.
|
||||||
not_rooms:
|
not_rooms:
|
||||||
description: A list of room IDs to exclude. If this list is absent then no rooms
|
description: A list of room IDs to exclude. If this list is absent then no rooms
|
||||||
are excluded. A matching room will be excluded even if it is listed in the `rooms`
|
are excluded. A matching room will be excluded even if it is listed in the `'rooms'`
|
||||||
filter.
|
filter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -17,15 +17,15 @@ properties:
|
||||||
event_fields:
|
event_fields:
|
||||||
description: List of event fields to include. If this list is absent then all
|
description: List of event fields to include. If this list is absent then all
|
||||||
fields are included. The entries are [dot-separated paths for each property](/appendices#dot-separated-property-paths)
|
fields are included. The entries are [dot-separated paths for each property](/appendices#dot-separated-property-paths)
|
||||||
to include. So `['content.body']` will include the `body` field of the `content` object.
|
to include. So ['content.body'] will include the 'body' field of the 'content' object.
|
||||||
A server may include more fields than were requested.
|
A server may include more fields than were requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
event_format:
|
event_format:
|
||||||
description: The format to use for events. `client` will return the events in
|
description: The format to use for events. 'client' will return the events in
|
||||||
a format suitable for clients. `federation` will return the raw event as received
|
a format suitable for clients. 'federation' will return the raw event as received
|
||||||
over federation. The default is `client`.
|
over federation. The default is 'client'.
|
||||||
enum:
|
enum:
|
||||||
- client
|
- client
|
||||||
- federation
|
- federation
|
||||||
|
|
@ -45,7 +45,7 @@ properties:
|
||||||
properties:
|
properties:
|
||||||
not_rooms:
|
not_rooms:
|
||||||
description: A list of room IDs to exclude. If this list is absent then no rooms
|
description: A list of room IDs to exclude. If this list is absent then no rooms
|
||||||
are excluded. A matching room will be excluded even if it is listed in the `rooms`
|
are excluded. A matching room will be excluded even if it is listed in the `'rooms'`
|
||||||
filter. This filter is applied before the filters in `ephemeral`,
|
filter. This filter is applied before the filters in `ephemeral`,
|
||||||
`state`, `timeline` or `account_data`
|
`state`, `timeline` or `account_data`
|
||||||
items:
|
items:
|
||||||
|
|
@ -65,7 +65,7 @@ properties:
|
||||||
events that appear in the `ephemeral` property in the `/sync`
|
events that appear in the `ephemeral` property in the `/sync`
|
||||||
response.
|
response.
|
||||||
include_leave:
|
include_leave:
|
||||||
description: Include rooms that the user has left in the sync. Defaults to `false`.
|
description: Include rooms that the user has left in the sync, default false
|
||||||
type: boolean
|
type: boolean
|
||||||
state:
|
state:
|
||||||
type: object
|
type: object
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,8 @@ properties:
|
||||||
When interacting with the REST API, this is the HTTP body.
|
When interacting with the REST API, this is the HTTP body.
|
||||||
type: object
|
type: object
|
||||||
type:
|
type:
|
||||||
description: The type of event, as defined by [the event type specification](/client-server-api/#types-of-room-events).
|
description: The type of event. This SHOULD be namespaced similar to Java package
|
||||||
|
naming conventions e.g. `com.example.subdomain.event.type`
|
||||||
type: string
|
type: string
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue