Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api docs: Improve documentation for user_settings transition.

This commit is contained in:
Tim Abbott 2021-08-01 15:07:53 -07:00
parent 8755a76cf6
commit 65d60f4a25
2 changed files with 156 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
templates/zerver/api/changelog.md
View File

@ -13,22 +13,24 @@ below features are supported.
**Feature level 89** **Feature level 89**
* [`GET /events`](/api/get-events): Introduced new event type * [`GET /events`](/api/get-events): Introduced the `user_settings`
`user_settings`. The previous `update_display_settings` and event type, unifying and replacing the previous
`update_global_notifications` event types are still supported `update_display_settings` and `update_global_notifications` event
for backwards compatibility, but will be removed in future. types. The legacy event types are still supported for backwards
* [`POST /register`](/api/register-queue): Added the new compatibility, but will be removed in a future release.
`user_settings_object` property to supported `client_capabilities`.
* [`GET /events`](/api/get-events): `update_display_settings` and
`update_global_notifications` are sent only when `user_settings_object`
is not included in the `client_capabilities` when registering the
event queue.
* [`POST /register`](/api/register-queue): Added `user_settings` field * [`POST /register`](/api/register-queue): Added `user_settings` field
in the response, which is a dictionary containing all the user settings. in the response, which is a dictionary containing all the user's
* [`POST /register`](/api/register-queue): User's personal settings in personal settings. For backwards-compatibility, individual settings
the top-level object are included in response only when `user_settings_object` will still appear in the top-level response for clients don't
is not included in the `client_capabilities` when registering the event support the `user_settings_object` client capability.
queue. * [`POST /register`](/api/register-queue): Added the
`user_settings_object` property to supported `client_capabilities`.
When enabled, the server will not include a duplicate copy of
personal settings in the top-level response.
* [`GET /events`](/api/get-events): `update_display_settings` and
`update_global_notifications` events now only sent to clients that
did not include `user_settings_object` in their
`client_capabilities` when the event queue was created.
**Feature level 88** **Feature level 88**

225
zerver/openapi/zulip.yaml
View File

@ -241,13 +241,14 @@ paths:
} }
- type: object - type: object
description: | description: |
Event sent to a user's clients when that user's display settings Event sent to clients that that have requested the
have changed with an additional rule that it is only sent to `update_display_settings` event type and did not include
clients that did not include `user_settings_object` in their `user_settings_object` in their `client_capabilities` when
`client_capabilities` when registering the event queue. registering the event queue.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), replaced by **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
the `user_settings` event type. connecting to newer servers should declare the `user_settings_object`
client capability and process the `user_settings` event type instead.
deprecated: true deprecated: true
properties: properties:
id: id:
@ -290,8 +291,9 @@ paths:
`user_settings_object` in their `client_capabilities` when `user_settings_object` in their `client_capabilities` when
registering the event queue. registering the event queue.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), replaced by **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
the `user_settings` event type. connecting to newer servers should declare the `user_settings_object`
client capability and process the `user_settings` event type instead.
deprecated: true deprecated: true
properties: properties:
id: id:
@ -8237,8 +8239,9 @@ paths:
client can handle the current API with null values for client can handle the current API with null values for
stream-level notification settings (which means the stream stream-level notification settings (which means the stream
is not customized and should inherit the user's global is not customized and should inherit the user's global
notification settings for stream messages). New in Zulip notification settings for stream messages).
2.1.0; in earlier Zulip releases, stream-level <br />
New in Zulip 2.1.0; in earlier Zulip releases, stream-level
notification settings were simple booleans. notification settings were simple booleans.
* `bulk_message_deletion`: Boolean for whether the client's * `bulk_message_deletion`: Boolean for whether the client's
@ -8246,7 +8249,9 @@ paths:
updated to process the new bulk format (with a updated to process the new bulk format (with a
`message_ids`, rather than a singleton `message_id`). `message_ids`, rather than a singleton `message_id`).
Otherwise, the server will send `delete_message` events Otherwise, the server will send `delete_message` events
in a loop. New in Zulip 3.0 (feature level 13). This in a loop.
<br />
New in Zulip 3.0 (feature level 13). This
capability is for backwards-compatibility; it will be capability is for backwards-compatibility; it will be
required in a future server release. required in a future server release.
@ -8257,11 +8262,12 @@ paths:
`avatar_url` field in the `realm_user` at its sole discretion `avatar_url` field in the `realm_user` at its sole discretion
to optimize network performance. This is an important optimization to optimize network performance. This is an important optimization
in organizations with 10,000s of users. in organizations with 10,000s of users.
<br />
New in Zulip 3.0 (feature level 18). New in Zulip 3.0 (feature level 18).
* `stream_typing_notifications`: Boolean for whether the client * `stream_typing_notifications`: Boolean for whether the client
supports stream typing notifications. supports stream typing notifications.
<br />
New in Zulip 4.0 (feature level 58). This capability is New in Zulip 4.0 (feature level 58). This capability is
for backwards-compatibility; it will be required in a for backwards-compatibility; it will be required in a
future server release. future server release.
@ -8270,8 +8276,17 @@ paths:
`user_settings` event type. If False, the server will additionally send the `user_settings` event type. If False, the server will additionally send the
legacy `update_display_settings` and `update_global_notifications` event legacy `update_display_settings` and `update_global_notifications` event
types for backwards-compatibility with clients that predate this API migration. types for backwards-compatibility with clients that predate this API migration.
<br />
New in Zulip 4.0 (feature level 89). This capability is for <br />
Because the feature level 89 API changes were merged together, clients can
safely make a request with this client capability and requesting all of the
`user_settings`, `update_display_settings`, and
`update_global_notifications` event types, and get exactly one copy of
settings data on any server version. (And then use the `zulip_feature_level`
in the `/register` response or the presence/absence of a `user_settings` key
to determine where to look).
<br />
New in Zulip 5.0 (feature level 89). This capability is for
backwards-compatibility; it will be removed in a future server release. backwards-compatibility; it will be removed in a future server release.
content: content:
application/json: application/json:
@ -9289,8 +9304,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_digest_emails: enable_digest_emails:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9303,8 +9319,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_login_emails: enable_login_emails:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9317,8 +9334,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_marketing_emails: enable_marketing_emails:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9331,8 +9349,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
email_notifications_batching_period_seconds: email_notifications_batching_period_seconds:
deprecated: true deprecated: true
type: integer type: integer
@ -9345,8 +9364,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_offline_email_notifications: enable_offline_email_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9359,8 +9379,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_offline_push_notifications: enable_offline_push_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9373,8 +9394,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_online_push_notifications: enable_online_push_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9387,8 +9409,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_sounds: enable_sounds:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9401,8 +9424,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_stream_desktop_notifications: enable_stream_desktop_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9415,8 +9439,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_stream_email_notifications: enable_stream_email_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9429,8 +9454,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_stream_push_notifications: enable_stream_push_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9443,8 +9469,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_stream_audible_notifications: enable_stream_audible_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9457,8 +9484,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
wildcard_mentions_notify: wildcard_mentions_notify:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9471,8 +9499,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
message_content_in_email_notifications: message_content_in_email_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9485,8 +9514,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
notification_sound: notification_sound:
deprecated: true deprecated: true
type: string type: string
@ -9499,8 +9529,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
pm_content_in_desktop_notifications: pm_content_in_desktop_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9513,8 +9544,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
desktop_icon_count_display: desktop_icon_count_display:
deprecated: true deprecated: true
type: integer type: integer
@ -9527,8 +9559,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
realm_name_in_notifications: realm_name_in_notifications:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9541,8 +9574,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
presence_enabled: presence_enabled:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9555,8 +9589,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
available_notification_sounds: available_notification_sounds:
deprecated: true deprecated: true
type: array type: array
@ -9571,8 +9606,9 @@ paths:
this Zulip server. Only relevant to support UI for configuring notification this Zulip server. Only relevant to support UI for configuring notification
sounds. sounds.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
color_scheme: color_scheme:
deprecated: true deprecated: true
type: integer type: integer
@ -9586,8 +9622,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
default_language: default_language:
deprecated: true deprecated: true
type: string type: string
@ -9601,8 +9638,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
demote_inactive_streams: demote_inactive_streams:
deprecated: true deprecated: true
type: integer type: integer
@ -9616,8 +9654,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
dense_mode: dense_mode:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9632,8 +9671,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
emojiset: emojiset:
deprecated: true deprecated: true
type: string type: string
@ -9647,8 +9687,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
enable_drafts_synchronization: enable_drafts_synchronization:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9661,8 +9702,11 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. New in Zulip 5.0 (feature level 87). connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
New in Zulip 5.0 (feature level 87).
fluid_layout_width: fluid_layout_width:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9676,8 +9720,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
default_view: default_view:
deprecated: true deprecated: true
type: string type: string
@ -9694,8 +9739,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
high_contrast_mode: high_contrast_mode:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9709,8 +9755,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
left_side_userlist: left_side_userlist:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9726,8 +9773,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
starred_message_counts: starred_message_counts:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9742,8 +9790,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
timezone: timezone:
deprecated: true deprecated: true
type: string type: string
@ -9758,8 +9807,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
translate_emoticons: translate_emoticons:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9774,8 +9824,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
twenty_four_hour_time: twenty_four_hour_time:
deprecated: true deprecated: true
type: boolean type: boolean
@ -9790,8 +9841,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
emojiset_choices: emojiset_choices:
deprecated: true deprecated: true
description: | description: |
@ -9808,8 +9860,9 @@ paths:
See [PATCH /settings](/api/update-settings) for details on See [PATCH /settings](/api/update-settings) for details on
the meaning of this setting. the meaning of this setting.
**Changes**: Deprecated in Zulip 5.0 (feature level 89), clients should **Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients
use `user_settings` dictionary instead. connecting to newer servers should declare the `user_settings_object`
client capability and access the `user_settings` object instead.
type: array type: array
items: items:
type: object type: object