paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-05 14:35:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Make API endpoint docs link to materials on REQ.

Browse Source 
This should help avoid bugs like the one in the previous commit.
This commit is contained in:
Tim Abbott
2019-04-23 11:30:38 -07:00
parent fa37401e69
commit d4893dfcbc
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/tutorials/documenting-api-endpoints.md
View File

@@ -118,8 +118,15 @@ The best way to find out what arguments an API endpoint takes is to
find the corresponding URL pattern in `zprojects/urls.py` and examining find the corresponding URL pattern in `zprojects/urls.py` and examining
the backend function that the URL pattern points to. the backend function that the URL pattern points to.
To understand how arguments are specified in Zulip backend endpoints,
read our [REST API tutorial][rest-api-tutorial], paying special
attention to the details of how `REQ` works.
[rest-api-tutorial]: ../tutorials/writing-views.html#writing-api-rest-endpoints
Be careful here! There's no currently automated testing verifying Be careful here! There's no currently automated testing verifying
that the arguments match the code. that the arguments match the code, so you need to be sure that you
understand precisely how each argument is formatted.
## Displaying example payloads/responses ## Displaying example payloads/responses