diff --git a/data/api/client-server/definitions/event_filter.yaml b/data/api/client-server/definitions/event_filter.yaml index d03c85da..ceb0d5bf 100644 --- a/data/api/client-server/definitions/event_filter.yaml +++ b/data/api/client-server/definitions/event_filter.yaml @@ -23,14 +23,14 @@ properties: not_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 - `'senders'` filter. + `senders` filter. items: type: string type: array not_types: 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 - 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. items: type: string @@ -43,7 +43,7 @@ properties: type: array types: 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. items: type: string diff --git a/data/api/client-server/definitions/room_event_filter.yaml b/data/api/client-server/definitions/room_event_filter.yaml index ab8ef79e..6c9b705d 100644 --- a/data/api/client-server/definitions/room_event_filter.yaml +++ b/data/api/client-server/definitions/room_event_filter.yaml @@ -39,7 +39,7 @@ allOf: for more information. Defaults to `false`. not_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. items: type: string diff --git a/data/api/client-server/definitions/sync_filter.yaml b/data/api/client-server/definitions/sync_filter.yaml index 75544e94..f181aa22 100644 --- a/data/api/client-server/definitions/sync_filter.yaml +++ b/data/api/client-server/definitions/sync_filter.yaml @@ -17,15 +17,15 @@ properties: event_fields: 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) - 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. items: type: string type: array event_format: - 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 - over federation. The default is 'client'. + 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 + over federation. The default is `client`. enum: - client - federation @@ -45,7 +45,7 @@ properties: properties: not_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`, `state`, `timeline` or `account_data` items: @@ -65,7 +65,7 @@ properties: events that appear in the `ephemeral` property in the `/sync` response. 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 state: type: object diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index ef71ca63..c3e54403 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -226,7 +226,7 @@ paths: type: boolean description: |- 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 third_party_instance_id: type: string @@ -277,4 +277,4 @@ components: accessTokenQuery: $ref: definitions/security.yaml#/accessTokenQuery accessTokenBearer: - $ref: definitions/security.yaml#/accessTokenBearer \ No newline at end of file + $ref: definitions/security.yaml#/accessTokenBearer diff --git a/data/api/client-server/login.yaml b/data/api/client-server/login.yaml index 7251d4ff..a668a6bc 100644 --- a/data/api/client-server/login.yaml +++ b/data/api/client-server/login.yaml @@ -148,7 +148,7 @@ paths: known client device, a new device will be created. The given device ID must not be the same as a [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. initial_device_display_name: type: string diff --git a/data/api/client-server/password_management.yaml b/data/api/client-server/password_management.yaml index b2d60559..3a1a570e 100644 --- a/data/api/client-server/password_management.yaml +++ b/data/api/client-server/password_management.yaml @@ -57,7 +57,7 @@ paths: type: boolean description: |- 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) for the user's remaining devices. diff --git a/data/api/client-server/registration.yaml b/data/api/client-server/registration.yaml index acb0b135..2813c0c2 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -126,7 +126,7 @@ paths: description: |- ID of the client device. If this does not correspond to a 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 initial_device_display_name: type: string @@ -139,11 +139,11 @@ paths: description: |- If true, an `access_token` and `device_id` should not be returned from this call, therefore preventing an automatic - login. Defaults to false. + login. Defaults to `false`. example: false refresh_token: type: boolean - description: If true, the client supports refresh tokens. + description: If `true`, the client supports refresh tokens. x-addedInMatrixVersion: "1.3" required: true responses: diff --git a/data/api/server-server/public_rooms.yaml b/data/api/server-server/public_rooms.yaml index 8beaecb2..41835f5a 100644 --- a/data/api/server-server/public_rooms.yaml +++ b/data/api/server-server/public_rooms.yaml @@ -49,7 +49,7 @@ paths: name: include_all_networks description: |- 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 schema: type: boolean @@ -121,7 +121,7 @@ paths: type: boolean description: |- 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 third_party_instance_id: type: string diff --git a/data/event-schemas/schema/m.room.server_acl.yaml b/data/event-schemas/schema/m.room.server_acl.yaml index c2ecf805..da490452 100644 --- a/data/event-schemas/schema/m.room.server_acl.yaml +++ b/data/event-schemas/schema/m.room.server_acl.yaml @@ -54,7 +54,7 @@ properties: type: boolean description: |- 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 with IP literal names are strongly discouraged in order to require