From 60c8b0123f986adb346ece7e2cba0831f47064af Mon Sep 17 00:00:00 2001 From: Sumanth V Rao Date: Wed, 7 Apr 2021 18:56:09 +0530 Subject: [PATCH] docs: Add a step to document feature level changes in zulip.yaml. --- docs/documentation/api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/documentation/api.md b/docs/documentation/api.md index fb3a253344..f156bf66dc 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -279,6 +279,12 @@ above. make sure that copy-pasting the code in your examples works, and 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 ## Why a custom system?