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

10 Commits

Author SHA1 Message Date
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 f0b099dbc0 docs: Make update-message-flags use curl example system. 2019-10-15 15:40:44 -07:00
Tim Abbott 297c79eaa9 api docs: Fix typo in name of has_alert_word message flag. 2019-06-27 11:55:15 -07:00
Anders Kaseorg a37fa74dce templates: Fix new low-hanging HTML validation problems. 
"http://localhost:9981/api/update-message-flags":318.16-319.34: error: “th” start tag in table body.
"http://localhost:9981/api/update-message-flags":344.35-344.38: error: Stray end tag “a”.
"http://localhost:9981/api/incoming-webhooks-walkthrough":412.4-412.77: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
 2019-06-24 23:20:17 -07:00
Hemanth V. Alluri c6b03432bc docs: modify update-message-flag to contain information about flags. 
This makes it a lot more useful for understanding how our flag update
endpoints work.

With significant edits by tabbott to explain what these are.

Fixes #12092.
 2019-06-04 00:40:47 -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
Eeshan Garg 9c589ac7d9 api docs: Stop mentioning "dev servers" in JS code examples. 
Since the Zulip API runs on both developement and production
servers, it is misleading to mention "dev servers" when discussing
zuliprc files.

Also, note that it is better to manually edit all of our JS
examples than to implement macro-like functionality that we use
for our Python examples. For our current purposes, it would be
too much work to build a full-blown testing framework for our
JS code examples just so that we can fix a minor wording issue.

Fixes #10672.
 2019-01-07 09:14:25 -08:00
Eeshan Garg b31bbbe649 api_docs: Use tabbed_sections extension in new API docs. 2018-10-17 15:32:35 -07:00
Tim Abbott 6487d956fe api docs: Fix typo in URL for bulk-mark-as-read. 2018-10-16 13:03:59 -07:00
Yago González 3d2b3f8fa4 api docs: Document the POST /messages/flags endpoint. 2018-10-16 12:19:24 -07:00