From d860b8e56867ef2cdc787a7a463e304cfdcfa1f6 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 23 Nov 2021 14:05:31 -0800 Subject: [PATCH] api docs: Update API docs and changelog for new setting. The commit 2c1a87166ca5bb4819fd71f78ada42dbb61d5ae7 did not properly document the new feature in the changelog; while I was at it, I wrote more detail in the field's description. --- templates/zerver/api/changelog.md | 5 +++++ zerver/openapi/zulip.yaml | 11 ++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/templates/zerver/api/changelog.md b/templates/zerver/api/changelog.md index 4e2484cbea..5303b11cae 100644 --- a/templates/zerver/api/changelog.md +++ b/templates/zerver/api/changelog.md @@ -20,6 +20,11 @@ format used by the Zulip server that they are interacting with. ## Changes in Zulip 5.0 +**Feature level 110** + +* [`POST /register`](/api/register-queue): Added + `server_web_public_streams_enabled` to the response. + **Feature level 109** * [`POST /register`](/api/register-queue), [`GET diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 28c185f81f..2926d3c83a 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -11105,9 +11105,14 @@ paths: description: | Present if `realm` is present in `fetch_event_types`. - Whether web public streams are enabled in the server. Similar topic_name - `realm_enable_spectator_access` but based on the `WEB_PUBLIC_STREAMS_ENABLED` - Zulip server level setting. + The value of the `WEB_PUBLIC_STREAMS_ENABLED` Zulip server level + setting. A server that has disabled this setting intends to not offer [web + public streams](/help/web-public-streams) to realms it hosts. (Zulip Cloud + defaults to `True`; self-hosted servers default to `False`). + + Clients should use this to determine whether to offer UI for the + realm-level setting for enabling we-public streams + (`realm_enable_spectator_access`). **Changes**: New in Zulip 5.0 (feature level 110). event_queue_longpoll_timeout_seconds: