Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
36,932 Commits 28 Branches 143 Tags 632 MiB
Commit Graph

9 Commits

Author SHA1 Message Date
orientor d2ee99a2fd openapi: Add markdown extension for rendering return values in API docs. 
Currently response return values have to be written twice, once in
the docs and once in zulip.yaml. Create a markdown extension so
that the return values in api docs are rendered using content from
zulip.yaml
 2020-05-29 15:02:56 -07:00
orientor 4d8c988ef2 openapi: Use description markdown for rendering endpoint descriptions. 
Firstly, change endpoint descriptions in zulip.yaml so that they
match their counterpart in the api docs. Then edit the api docs
so that they use api description markdown extension for displaying
endpoint description.
 2020-04-28 12:57:19 -07:00
Vishnu KS 70e8f5ce8a docs: Make get-user-groups use curl example system. 2019-10-15 15:53:03 -07:00
Tim Abbott 8c9dd6198f api docs: Use Help Center syntax for restricted endpoints. 2019-07-29 16:17:54 -07:00
Hemanth V. Alluri c85640d6b1 docs: Fix cURL example in get-user-groups.md. 
The issue here was that the endpoint was documented as being
contactable by bots when in reality we have a require_member_or_admin
decorator on the endpoint. So bots and guests cannot contact it.
 2019-07-29 16:09:11 -07:00
Tim Abbott 6763e77ee2 api docs: Fix syntax for get-user-groups. 
This apparently had some sort of rebase conflict issue with the
migration to the nicer syntax for tabs.
 2019-06-24 22:24:46 -07:00
Eeshan Garg cecea75457 api_docs: Detect missing arguments in curl examples. 
This commit adds automated tests that make sure that every curl
example command in our API docs has the '-X (POST|GET)' argument.

Fixes: #11927
 2019-05-28 16:53:48 -07:00
Sameer Choubey bde8b40473 api_docs: Add explicit '-X GET' to curl examples. 
When passing arguments with the `-d` syntax, which is convenient for 
command-line examples, one needs to specify `-X GET` for curl to work
properly.

Fixes #12116
 2019-04-17 12:08:35 -07:00
Roman Godov aa3682f9fc api: Add GET /user_groups documentation. 
This documents our GET endpoint for interacting with Zulip's user
groups feature.

Fixes #10298.
 2018-11-08 22:19:30 -08:00