From 1685d207c8ff9e07e976f0fd92ec74660241df8d Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 4 Aug 2021 10:48:42 -0700 Subject: [PATCH] api docs: Fix API documentation bugs issues with last commit. * Actually bump API_FEATURE_LEVEL. * Document changes in the endpoint documentation as well. * Use standard linking/wording approach in API changelog. --- templates/zerver/api/changelog.md | 10 +++++----- version.py | 2 +- zerver/openapi/zulip.yaml | 4 ++++ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/templates/zerver/api/changelog.md b/templates/zerver/api/changelog.md index 705689b084..6fe7d506f2 100644 --- a/templates/zerver/api/changelog.md +++ b/templates/zerver/api/changelog.md @@ -13,11 +13,11 @@ below features are supported. **Feature level 90** -* We no longer include `sender_ids` in the `streams` section of - `UnreadMessagesResult`, which becomes the `unread_msgs` section of - the events that clients fetch when registering events at page - load time. (We don't believe this feature has ever been used in - a meaningful way.) +* [`POST /register`](/api/register-queue): The `unread_msgs` section + of the response no longer includes `sender_ids` in the `streams` + dictionaries. These were removed because no clients were interested + in using the data, which required substantial complexity to + construct correctly. **Feature level 89** diff --git a/version.py b/version.py index 5a25fd3f13..101347bc48 100644 --- a/version.py +++ b/version.py @@ -33,7 +33,7 @@ DESKTOP_WARNING_VERSION = "5.4.3" # Changes should be accompanied by documentation explaining what the # new level means in templates/zerver/api/changelog.md, as well as # "**Changes**" entries in the endpoint's documentation in `zulip.yaml`. -API_FEATURE_LEVEL = 89 +API_FEATURE_LEVEL = 90 # 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 diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index f1da968ef7..64335ad02e 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -8857,6 +8857,10 @@ paths: An array of dictionaries where each dictionary contains details of all unread messages of a single subscribed stream, including muted streams. + + **Changes**: Prior to Zulip 5.0 (feature level 90), the + dictionaries included an additional `sender_ids` key listing + the set of IDs of users who had sent the unread messages. items: type: object description: |