mirror of
https://github.com/zulip/zulip.git
synced 2025-10-27 01:53:59 +00:00
api: Document meaning for twenty_four_hour_time=null.
This documentation-only change will allow us to add that as a valid value in the future, by having client implementations not crash on seeing the value. See [the API design discussion](https://chat.zulip.org/#narrow/channel/378-api-design/topic/.60user_settings.2Etwenty_four_hour_time.60/near/2220575).
This commit is contained in:
@@ -34,7 +34,7 @@ DESKTOP_WARNING_VERSION = "5.9.3"
|
||||
# new level means in api_docs/changelog.md, as well as "**Changes**"
|
||||
# entries in the endpoint's documentation in `zulip.yaml`.
|
||||
|
||||
API_FEATURE_LEVEL = 407
|
||||
API_FEATURE_LEVEL = 408
|
||||
|
||||
# Bump the minor PROVISION_VERSION to indicate that folks should provision
|
||||
# only when going from an old version of the code to a newer version. Bump
|
||||
|
||||
@@ -16968,8 +16968,16 @@ paths:
|
||||
properties:
|
||||
twenty_four_hour_time:
|
||||
type: boolean
|
||||
nullable: true
|
||||
description: |
|
||||
Whether time should be [displayed in 24-hour notation](/help/change-the-time-format).
|
||||
|
||||
A `null` value indicates that the client should use the default time
|
||||
format for the user's locale.
|
||||
|
||||
**Changes**: Prior to Zulip 11.0 (feature level 408), `null`
|
||||
was not a valid value for this setting. Note that it was not possible
|
||||
to actually set the time format to `null` at this feature level.
|
||||
web_mark_read_on_scroll_policy:
|
||||
type: integer
|
||||
description: |
|
||||
@@ -19817,14 +19825,21 @@ paths:
|
||||
properties:
|
||||
twenty_four_hour_time:
|
||||
type: boolean
|
||||
nullable: true
|
||||
description: |
|
||||
Whether time should be [displayed in 24-hour notation](/help/change-the-time-format).
|
||||
|
||||
**Changes**: New in Zulip 5.0 (feature level 99).
|
||||
This value was previously available as
|
||||
`realm_default_twenty_four_hour_time` in
|
||||
the top-level response object (only when `realm` was
|
||||
present in `fetch_event_types`).
|
||||
A `null` value indicates that the client should use the default time
|
||||
format for the user's locale.
|
||||
|
||||
**Changes**: Prior to Zulip 11.0 (feature level 408), `null`
|
||||
was not a valid value for this setting. Note that it was not possible
|
||||
to actually set the time format to `null` at this feature level.
|
||||
|
||||
New in Zulip 5.0 (feature level 99). This value was previously
|
||||
available as `realm_default_twenty_four_hour_time` in the top-level
|
||||
response object (only when `realm` was present in
|
||||
`fetch_event_types`).
|
||||
web_mark_read_on_scroll_policy:
|
||||
type: integer
|
||||
description: |
|
||||
|
||||
Reference in New Issue
Block a user