From 2b9220ff58da18a7f03f4f1c1b19da40da945246 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 12 Mar 2024 14:48:05 +0100 Subject: [PATCH] api-docs: Update feature level 224 changelog and **Changes** notes. Links to the available message flag table in the feature level 224 changelog entry, as there are relevant **Changes** notes for this feature level in that part of the API documentation. Updates the order and formatting of these new and deprecated flags in the available flags table. Also, adds a link to the topic wildcard mentions section of the help center documentation. Makes small clean ups to the changes notes for this feature level, as well as the changelog entry itself. The original commit for these feature level 224 API changes was c597de6a1d7. --- api_docs/changelog.md | 9 ++- zerver/openapi/zulip.yaml | 118 +++++++++++++++++++++----------------- 2 files changed, 70 insertions(+), 57 deletions(-) diff --git a/api_docs/changelog.md b/api_docs/changelog.md index 56cca108ed..1794441747 100644 --- a/api_docs/changelog.md +++ b/api_docs/changelog.md @@ -204,9 +204,12 @@ No changes; feature level used for Zulip 8.0 release. **Feature level 224** * [`GET /events`](/api/get-events), [`GET /messages`](/api/get-messages), - [`GET /messages/{message_id}`](/api/get-message): The `wildcard_mentioned` - flag was deprecated, replaced with `stream_wildcard_mentioned` and - `topic_wildcard_mentioned`, but it is still available for backwards compatibility. + [`GET /messages/{message_id}`](/api/get-message): Of the [available + message flags](/api/update-message-flags#available-flags) that a user + may have for a message, the `wildcard_mentioned` flag was + deprecated in favor of the `stream_wildcard_mentioned` and + `topic_wildcard_mentioned` flags, but it is still available for + backwards compatibility. **Feature level 223** diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 251e98b097..26a2ff4fc8 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -958,13 +958,14 @@ paths: in a new message that the server has already marked as read for the user. - **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` flag - was deprecated in favor of the `stream_wildcard_mentioned` and `topic_wildcard_mentioned` - flags. The `wildcard_mentioned` flag exists for backwards compatibility with - older clients and equals `stream_wildcard_mentioned` || `topic_wildcard_mentioned`. - Clients interacting with older servers should treat this field as an old name - for `stream_wildcard_mentioned`. @topic mentions were not available prior to - this feature level. + **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` + flag was deprecated in favor of the `stream_wildcard_mentioned` and + `topic_wildcard_mentioned` flags. The `wildcard_mentioned` flag exists + for backwards compatibility with older clients and equals + `stream_wildcard_mentioned || topic_wildcard_mentioned`. Clients + supporting older server versions should treat this field as a previous + name for the `stream_wildcard_mentioned` flag as topic wildcard mentions + were not available prior to this feature level. [message-flags]: /api/update-message-flags#available-flags items: @@ -2412,13 +2413,14 @@ paths: to identify cases where a mention or alert word was added by the edit. - **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` flag - was deprecated in favor of the `stream_wildcard_mentioned` and `topic_wildcard_mentioned` - flags. The `wildcard_mentioned` flag exists for backwards compatibility with - older clients and equals `stream_wildcard_mentioned` || `topic_wildcard_mentioned`. - Clients interacting with older servers should treat this field as an old name - for `stream_wildcard_mentioned`. @topic mentions were not available prior to - this feature level. + **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` + flag was deprecated in favor of the `stream_wildcard_mentioned` and + `topic_wildcard_mentioned` flags. The `wildcard_mentioned` flag exists + for backwards compatibility with older clients and equals + `stream_wildcard_mentioned || topic_wildcard_mentioned`. Clients + supporting older server versions should treat this field as a previous + name for the `stream_wildcard_mentioned` flag as topic wildcard mentions + were not available prior to this feature level. [message-flags]: /api/update-message-flags#available-flags items: @@ -6318,13 +6320,14 @@ paths: description: | The user's [message flags][message-flags] for the message. - **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` flag - was deprecated in favor of the `stream_wildcard_mentioned` and `topic_wildcard_mentioned` - flags. The `wildcard_mentioned` flag exists for backwards compatibility with - older clients and equals `stream_wildcard_mentioned` || `topic_wildcard_mentioned`. - Clients interacting with older servers should treat this field as an old name - for `stream_wildcard_mentioned`. @topic mentions were not available prior to - this feature level. + **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` + flag was deprecated in favor of the `stream_wildcard_mentioned` and + `topic_wildcard_mentioned` flags. The `wildcard_mentioned` flag exists + for backwards compatibility with older clients and equals + `stream_wildcard_mentioned || topic_wildcard_mentioned`. Clients + supporting older server versions should treat this field as a previous + name for the `stream_wildcard_mentioned` flag as topic wildcard mentions + were not available prior to this feature level. [message-flags]: /api/update-message-flags#available-flags items: @@ -6837,44 +6840,28 @@ paths: a mention of the current user. - - wildcard_mentioned - - Whether this message contained either a - stream wildcard mention - like @**all** or a topic wildcard mention (@**topic**). Cannot be changed - by the user directly, but can change if the message is edited to add/remove - a stream or/and topic wildcard mention. - - **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` flag - was deprecated in favor of the `stream_wildcard_mentioned` and `topic_wildcard_mentioned` - flags. The `wildcard_mentioned` flag exists for backwards compatibility with - older clients and equals `stream_wildcard_mentioned` || `topic_wildcard_mentioned`. - Clients interacting with older servers should treat this field as an old name - for `stream_wildcard_mentioned`. @topic mentions were not available prior to - this feature level. - - stream_wildcard_mentioned Whether this message contained a stream wildcard mention - like @**all**. Cannot be changed by the user directly, but + (like @**all**). Cannot be changed by the user directly, but can change if the message is edited to add/remove a stream wildcard mention. - - **Changes**: New in Zulip 8.0 (feature level 224). +

+ Changes: New in Zulip 8.0 (feature level 224). topic_wildcard_mentioned - Whether this message contained a topic wildcard mention (@**topic**). + Whether this message contained a + topic wildcard mention + (@**topic**). Cannot be changed by the user directly, but can change if the message is edited to add/remove a topic wildcard mention. - - **Changes**: New in Zulip 8.0 (feature level 224). +

+ Changes: New in Zulip 8.0 (feature level 224). has_alert_word @@ -6889,14 +6876,36 @@ paths: historical - Is `true` for messages that the user did not receive + Is true for messages that the user did not receive at the time they were sent but later was added to - the user's history (E.g. because they starred or + the user's history (e.g. because they starred or reacted to a message sent to a public stream before they subscribed to that stream). Cannot be changed by the user directly. + + wildcard_mentioned + + Whether this message contained either a + stream wildcard mention + (like @**all**) or a + topic wildcard mention + (@**topic**). Cannot be changed by the user directly, but can change if + the message is edited to add/remove a stream and/or topic wildcard + mention. +

+ Changes: Deprecated in Zulip 8.0 (feature level 224), in favor of + the stream_wildcard_mentioned and + topic_wildcard_mentioned flags. The + wildcard_mentioned flag exists for backwards compatibility + with older clients and equals + stream_wildcard_mentioned || topic_wildcard_mentioned. + Clients supporting older server versions should treat this field as a + previous name for the stream_wildcard_mentioned flag as + topic wildcard mentions were not available prior to this feature level. + + @@ -7597,13 +7606,14 @@ paths: description: | The user's [message flags][message-flags] for the message. - **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` flag - was deprecated in favor of the `stream_wildcard_mentioned` and `topic_wildcard_mentioned` - flags. The `wildcard_mentioned` flag exists for backwards compatibility with - older clients and equals `stream_wildcard_mentioned` || `topic_wildcard_mentioned`. - Clients interacting with older servers should treat this field as an old name - for `stream_wildcard_mentioned`. @topic mentions were not available prior to - this feature level. + **Changes**: In Zulip 8.0 (feature level 224), the `wildcard_mentioned` + flag was deprecated in favor of the `stream_wildcard_mentioned` and + `topic_wildcard_mentioned` flags. The `wildcard_mentioned` flag exists + for backwards compatibility with older clients and equals + `stream_wildcard_mentioned || topic_wildcard_mentioned`. Clients + supporting older server versions should treat this field as a previous + name for the `stream_wildcard_mentioned` flag as topic wildcard mentions + were not available prior to this feature level. [message-flags]: /api/update-message-flags#available-flags items: