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

docs: Add a step to document feature level changes in zulip.yaml.

This commit is contained in:
Sumanth V Rao 2021-04-07 18:56:09 +05:30 committed by Tim Abbott
parent 75e539b7a7
commit 60c8b0123f
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/documentation/api.md
View File

@ -279,6 +279,12 @@ above.
make sure that copy-pasting the code in your examples works, and make sure that copy-pasting the code in your examples works, and
post an example of the output in the pull request. post an example of the output in the pull request.
1. Document the new API in `templates/zerver/api/changelog.md` and
bump the `API_FEATURE_LEVEL` in `version.py`. Also, make sure to
add a `**Changes**` entry in the description of the new API/event
in `zerver/openapi/zulip.yaml`, which mentions the API feature level
at which they were added.
[javascript-examples]: https://github.com/zulip/zulip-js/tree/master/examples [javascript-examples]: https://github.com/zulip/zulip-js/tree/master/examples
## Why a custom system? ## Why a custom system?