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

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
c597de6a1d.
This commit is contained in:
Lauryn Menard 2024-03-12 14:48:05 +01:00 committed by Tim Abbott
parent 6c0818ff51
commit 2b9220ff58
2 changed files with 70 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api_docs/changelog.md
View File

@ -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**

118
zerver/openapi/zulip.yaml
View File

@ -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.
</td>
</tr>
<tr>
<td><code>wildcard_mentioned</code></td>
<td>
Whether this message contained either a
<a href="/help/mention-a-user-or-group#mention-everyone-on-a-stream">stream wildcard mention</a>
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.
</td>
</tr>
<tr>
<td><code>stream_wildcard_mentioned</code></td>
<td>
Whether this message contained a
<a href="/help/mention-a-user-or-group#mention-everyone-on-a-stream">stream wildcard mention</a>
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).
<br /><br />
<b>Changes</b>: New in Zulip 8.0 (feature level 224).
</td>
</tr>
<tr>
<td><code>topic_wildcard_mentioned</code></td>
<td>
Whether this message contained a topic wildcard mention (@**topic**).
Whether this message contained a
<a href="/help/mention-a-user-or-group#mention-all-topic-participants">topic wildcard mention</a>
(@**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).
<br /><br />
<b>Changes</b>: New in Zulip 8.0 (feature level 224).
</td>
<tr>
<td><code>has_alert_word</code></td>
@ -6889,14 +6876,36 @@ paths:
<tr>
<td><code>historical</code></td>
<td>
Is `true` for messages that the user did not receive
Is <code>true</code> 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.
</td>
</tr>
<tr>
<td><code>wildcard_mentioned</code></td>
<td>
Whether this message contained either a
<a href="/help/mention-a-user-or-group#mention-everyone-on-a-stream">stream wildcard mention</a>
(like @**all**) or a
<a href="/help/mention-a-user-or-group#mention-all-topic-participants">topic wildcard mention</a>
(@**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.
<br /><br />
<b>Changes</b>: Deprecated in Zulip 8.0 (feature level 224), in favor of
the <code>stream_wildcard_mentioned</code> and
<code>topic_wildcard_mentioned</code> flags. The
<code>wildcard_mentioned</code> flag exists for backwards compatibility
with older clients and equals
<code>stream_wildcard_mentioned || topic_wildcard_mentioned</code>.
Clients supporting older server versions should treat this field as a
previous name for the <code>stream_wildcard_mentioned</code> flag as
topic wildcard mentions were not available prior to this feature level.
</td>
</tr>
</tbody>
</table>
</div>
@ -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: