paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document new create-api-changelog tool.

Browse Source
This commit is contained in:
Vector73
2025-03-01 18:25:11 +00:00
committed by Tim Abbott
parent 118eaffd3a
commit ad3886e142
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/documentation/api.md
View File

@@ -333,11 +333,15 @@ 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 `api_docs/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.
1. Run `./tools/create-api-changelog` which will create a new empty
changelog file in `api_docs/unmerged.d/` directory. Open this
file and document the API changes. The content of this file will be
merged into `api_docs/changelog.md` when your commit is merged into the
`main` branch.
1. Add a `**Changes**` entry in the description of the new API/event in
`zerver/openapi/zulip.yaml`, and mention the name of the file generated
in the previous step in place of the API feature level.
## Why a custom system?