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

api docs: Update API docs and changelog for new setting. 

The commit 2c1a87166c did not properly
document the new feature in the changelog; while I was at it, I wrote
more detail in the field's description.
This commit is contained in:
Tim Abbott 2021-11-23 14:05:31 -08:00
parent 5607712794
commit d860b8e568
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
templates/zerver/api/changelog.md
View File

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

11
zerver/openapi/zulip.yaml
View File

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