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

docs: Improve introduction for API changelog page. 

This links to the release lifecycle documentation and is a bit more
explicit about how to use this.

Probably further improvement would be useful as well.
This commit is contained in:
Tim Abbott 2021-11-02 14:14:49 -07:00
parent dd5cad549c
commit 3871c99104
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,13 +1,22 @@
# API changelog
This page documents changes to the Zulip Server API over time. See also
the [Zulip server changelog][server-changelog].
This page documents changes to the Zulip Server API over time. See
also the [Zulip release lifecycle](../overview/release-lifecycle.md)
for background on why this API changelog is important, and the [Zulip
server changelog][server-changelog].
The recommended way for a client like the Zulip mobile or desktop apps
that needs to support interaction with a wide range of different Zulip
server versions is to check the `zulip_feature_level` parameter in the
`/register` and `/server_settings` responses to determine which of the
below features are supported.
The API feature levels system used in this changelog is designed to
make it possible to write API clients, such as the Zulip mobile and
terminal apps, that work with a wide range of Zulip server
versions. Every change to the Zulip API is recorded both here and in
**Changes** entries in the API documentation for the modified
endpoint(s).
When using an API endpoint whose behavior has changed, Zulip API
clients should check the `zulip_feature_level` field, present in the
[`GET /server_settings`](/api/get-server-settings) and [`POST
/register`](/api/register-queue) responses, to determine the API
format used by the Zulip server that they are interacting with.
## Changes in Zulip 5.0