diff --git a/data/api/client-server/definitions/sync_filter.yaml b/data/api/client-server/definitions/sync_filter.yaml index 0ea6e9c2..d38029e5 100644 --- a/data/api/client-server/definitions/sync_filter.yaml +++ b/data/api/client-server/definitions/sync_filter.yaml @@ -16,10 +16,9 @@ title: Filter properties: event_fields: description: List of event fields to include. If this list is absent then all - fields are included. The entries may include '.' characters to indicate sub-fields. - So ['content.body'] will include the 'body' field of the 'content' object. A - literal '.' character in a field name may be escaped using a '\\'. A server may - include more fields than were requested. + 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. + A server may include more fields than were requested. items: type: string type: array