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

api_docs: Update the "Changes" section of narrows to refer changelog. 

Previously, the "Changes" sections for narrows in the api_docs
used to mention the entire set of changes for the narrow. This
commit replaces it to rather refer to the changelog at
[Construct a narrow](/api/construct-narrow).

This avoids the risk of the details getting out of sync between
the different descriptions, and reduces the burden for updating
or editing them.
This commit is contained in:
roanster007 2024-05-30 03:33:07 +05:30 committed by Tim Abbott
parent 7b1a5d84fc
commit f905bfdcce
1 changed files with 4 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
zerver/openapi/zulip.yaml
View File

@ -6207,23 +6207,7 @@ paths:
subscribed to appropriate channels or use a shared history subscribed to appropriate channels or use a shared history
search narrow with this endpoint. search narrow with this endpoint.
**Changes**: In Zulip 9.0 (feature level 250), narrows gained support **Changes**: See changelog at [Construct a narrow](/api/construct-narrow).
for two new filters related to channel messages: `channel` and `channels`;
which are aliases for (and return the same results as) the `stream` and
`streams` filters respectively.
In Zulip 9.0 (feature level 249), narrows gained support for a new
filter, `has:reaction`, which returns messages with at least one
[emoji reaction](/help/emoji-reactions).
In Zulip 7.0 (feature level 177), narrows gained support
for three new filters related to direct messages: `is:dm`, `dm` and
`dm-including`; replacing and deprecating `is:private`, `pm-with` and
`group-pm-with` respectively.
In Zulip 2.1.0, added support for using user/channel IDs when
constructing narrows for a message's sender, its channel and/or
its recipient(s).
content: content:
application/json: application/json:
schema: schema:
@ -7086,19 +7070,7 @@ paths:
optimization. Including that filter takes advantage of the fact that optimization. Including that filter takes advantage of the fact that
the server has a database index for unread messages. the server has a database index for unread messages.
**Changes**: In Zulip 9.0 (feature level 250), narrows gained support **Changes**: See changelog at [Construct a narrow](/api/construct-narrow).
for two new filters related to channel messages: `channel` and `channels`;
which are aliases for (and return the same results as) the `stream` and
`streams` filters respectively.
In Zulip 9.0 (feature level 249), narrows gained support for a new
filter, `has:reaction`, which returns messages with at least one
[emoji reaction](/help/emoji-reactions).
In Zulip 7.0 (feature level 177), narrows gained support
for three new filters related to direct messages: `is:dm`, `dm` and
`dm-including`; replacing and deprecating `is:private`, `pm-with` and
`group-pm-with` respectively.
type: array type: array
items: items:
oneOf: oneOf:
@ -7519,19 +7491,7 @@ paths:
A structure defining the narrow to check against. See how to A structure defining the narrow to check against. See how to
[construct a narrow](/api/construct-narrow). [construct a narrow](/api/construct-narrow).
**Changes**: In Zulip 9.0 (feature level 250), narrows gained support **Changes**: See changelog at [Construct a narrow](/api/construct-narrow).
for two new filters related to channel messages: `channel` and `channels`;
which are aliases for (and return the same results as) the `stream` and
`streams` filters respectively.
In Zulip 9.0 (feature level 249), narrows gained support for a new
filter, `has:reaction`, which returns messages with at least one
[emoji reaction](/help/emoji-reactions).
In Zulip 7.0 (feature level 177), narrows gained support
for three new filters related to direct messages: `is:dm`, `dm` and
`dm-including`; replacing and deprecating `is:private`, `pm-with` and
`group-pm-with` respectively.
content: content:
application/json: application/json:
schema: schema:
@ -22033,19 +21993,7 @@ components:
See the `all_public_streams` parameter for how to process all See the `all_public_streams` parameter for how to process all
public channel messages in an organization. public channel messages in an organization.
**Changes**: In Zulip 9.0 (feature level 250), narrows gained support **Changes**: See changelog at [Construct a narrow](/api/construct-narrow).
for two new filters related to channel messages: `channel` and `channels`;
which are aliases for (and return the same results as) the `stream` and
`streams` filters respectively.
In Zulip 9.0 (feature level 249), narrows gained support for a new
filter, `has:reaction`, which returns messages with at least one
[emoji reaction](/help/emoji-reactions).
In Zulip 7.0 (feature level 177), narrows gained support
for three new filters related to direct messages: `is:dm`, `dm` and
`dm-including`; replacing and deprecating `is:private`, `pm-with` and
`group-pm-with` respectively.
type: array type: array
items: items:
type: array type: array