mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-01 17:24:10 +01:00
format some literals and keywords
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
This commit is contained in:
parent
afa06ad330
commit
15a5cff2e0
|
|
@ -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, default false
|
description: Include rooms that the user has left in the sync. Defaults to `false`.
|
||||||
type: boolean
|
type: boolean
|
||||||
state:
|
state:
|
||||||
type: object
|
type: object
|
||||||
|
|
|
||||||
|
|
@ -226,7 +226,7 @@ paths:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
Whether or not to include all known networks/protocols from
|
Whether or not to include all known networks/protocols from
|
||||||
application services on the homeserver. Defaults to false.
|
application services on the homeserver. Defaults to `false`.
|
||||||
example: false
|
example: false
|
||||||
third_party_instance_id:
|
third_party_instance_id:
|
||||||
type: string
|
type: string
|
||||||
|
|
@ -277,4 +277,4 @@ components:
|
||||||
accessTokenQuery:
|
accessTokenQuery:
|
||||||
$ref: definitions/security.yaml#/accessTokenQuery
|
$ref: definitions/security.yaml#/accessTokenQuery
|
||||||
accessTokenBearer:
|
accessTokenBearer:
|
||||||
$ref: definitions/security.yaml#/accessTokenBearer
|
$ref: definitions/security.yaml#/accessTokenBearer
|
||||||
|
|
|
||||||
|
|
@ -148,7 +148,7 @@ paths:
|
||||||
known client device, a new device will be created. The given
|
known client device, a new device will be created. The given
|
||||||
device ID must not be the same as a
|
device ID must not be the same as a
|
||||||
[cross-signing](/client-server-api/#cross-signing) key ID.
|
[cross-signing](/client-server-api/#cross-signing) key ID.
|
||||||
The server will auto-generate a device_id
|
The server will auto-generate a `device_id`
|
||||||
if this is not specified.
|
if this is not specified.
|
||||||
initial_device_display_name:
|
initial_device_display_name:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,7 @@ paths:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
Whether the user's other access tokens, and their associated devices, should be
|
Whether the user's other access tokens, and their associated devices, should be
|
||||||
revoked if the request succeeds. Defaults to true.
|
revoked if the request succeeds. Defaults to `true`.
|
||||||
|
|
||||||
When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout)
|
When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout)
|
||||||
for the user's remaining devices.
|
for the user's remaining devices.
|
||||||
|
|
|
||||||
|
|
@ -126,7 +126,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
ID of the client device. If this does not correspond to a
|
ID of the client device. If this does not correspond to a
|
||||||
known client device, a new device will be created. The server
|
known client device, a new device will be created. The server
|
||||||
will auto-generate a device_id if this is not specified.
|
will auto-generate a `device_id` if this is not specified.
|
||||||
example: GHTYAJCE
|
example: GHTYAJCE
|
||||||
initial_device_display_name:
|
initial_device_display_name:
|
||||||
type: string
|
type: string
|
||||||
|
|
@ -139,11 +139,11 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
If true, an `access_token` and `device_id` should not be
|
If true, an `access_token` and `device_id` should not be
|
||||||
returned from this call, therefore preventing an automatic
|
returned from this call, therefore preventing an automatic
|
||||||
login. Defaults to false.
|
login. Defaults to `false`.
|
||||||
example: false
|
example: false
|
||||||
refresh_token:
|
refresh_token:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: If true, the client supports refresh tokens.
|
description: If `true`, the client supports refresh tokens.
|
||||||
x-addedInMatrixVersion: "1.3"
|
x-addedInMatrixVersion: "1.3"
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,7 @@ paths:
|
||||||
name: include_all_networks
|
name: include_all_networks
|
||||||
description: |-
|
description: |-
|
||||||
Whether or not to include all networks/protocols defined by application
|
Whether or not to include all networks/protocols defined by application
|
||||||
services on the homeserver. Defaults to false.
|
services on the homeserver. Defaults to `false`.
|
||||||
example: false
|
example: false
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
|
@ -121,7 +121,7 @@ paths:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
Whether or not to include all known networks/protocols from
|
Whether or not to include all known networks/protocols from
|
||||||
application services on the homeserver. Defaults to false.
|
application services on the homeserver. Defaults to `false`.
|
||||||
example: false
|
example: false
|
||||||
third_party_instance_id:
|
third_party_instance_id:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ properties:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
True to allow server names that are IP address literals. False to
|
True to allow server names that are IP address literals. False to
|
||||||
deny. Defaults to true if missing or otherwise not a boolean.
|
deny. Defaults to `true` if missing or otherwise not a boolean.
|
||||||
|
|
||||||
This is strongly recommended to be set to `false` as servers running
|
This is strongly recommended to be set to `false` as servers running
|
||||||
with IP literal names are strongly discouraged in order to require
|
with IP literal names are strongly discouraged in order to require
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue