Rishi Gupta
1c264dedc5
api docs: Change Shakespeare quote.
...
The previous quote doesn't come off well if you don't know the reference
(which the majority of our users will not).
2018-10-22 15:44:36 -07:00
Rishi Gupta
c37384f63d
api docs: Update writing-bots.
...
Removes the intro material since there are better places for it.
2018-10-20 13:31:19 -07:00
Rishi Gupta
6b8de50c50
api docs: Update running-bots.
...
This page still has some work needed, but will probably require coordination
with the product work as well.
2018-10-20 13:31:19 -07:00
Rishi Gupta
796a1a6582
api docs: Update non-webhook-integrations.md.
...
Addresses comments on a8e1225
.
2018-10-20 13:31:19 -07:00
Eeshan Garg
b31bbbe649
api_docs: Use tabbed_sections extension in new API docs.
2018-10-17 15:32:35 -07:00
Eeshan Garg
5275d49f05
api_docs: Properly escape arguments passed to curl.
...
Fixes #8484 .
2018-10-17 15:32:35 -07:00
Rishi Gupta
d76f728dda
api docs: Rename webhook-walkthrough to incoming-webhooks-walkthrough.
2018-10-16 21:07:00 -07:00
Rishi Gupta
6a352ab249
api docs: Add script and plugin integrations to integrations-overview.
2018-10-16 21:07:00 -07:00
Rishi Gupta
df20f1a47f
api docs: Rename integration-guide.md to non-webhook-integrations.md.
2018-10-16 21:07:00 -07:00
Rishi Gupta
cd81b0766a
api docs: Move references to integration-guide to integrations-overview.
2018-10-16 21:06:59 -07:00
Rishi Gupta
a8e1225a6b
api docs: Update integration-guide.
2018-10-16 21:06:59 -07:00
Rishi Gupta
c3eb922559
api docs: Move general advice to incoming webhooks guide.
...
One of the bullets does reference APIs, which aren't relevant to incoming
webhooks, but decided to leave it as is.
2018-10-16 21:06:59 -07:00
Rishi Gupta
decc5352aa
api docs: Update webhook-walkthrough.
2018-10-16 21:06:59 -07:00
Rishi Gupta
47cddf4acf
api docs: Update incoming-webhooks-overview.md.
2018-10-16 21:06:59 -07:00
Rishi Gupta
4abce1783f
api docs: Restructure integrations section and add an overview.
2018-10-16 21:06:59 -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
029d815be7
api docs: Document the /dev_fetch_api_key endpoint.
2018-10-16 12:47:12 -07:00
Yago González
3eeec94d03
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-10-16 12:38:27 -07:00
Yago González
3d2b3f8fa4
api docs: Document the POST /messages/flags endpoint.
2018-10-16 12:19:24 -07:00
Yago González
7a4103eee6
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-10-16 12:12:05 -07:00
Tim Abbott
5272ac8c39
api docs: Fix a broken linkification filters link.
2018-10-16 12:03:38 -07:00
Tim Abbott
d13bd6e8d3
linkifiers: Rename articles to current feature name.
...
These were previously called "linkification filters", but we now want
to consistently refer to them as "linkifiers" in the UI and API docs.
2018-10-16 12:01:17 -07:00
Yago González
3bdc8f9946
api: Document the GET /realm/emoji endpoint.
2018-10-16 11:51:48 -07:00
Yago González
7a7b507e86
api docs: Document DELETE /realm/filters/<filter_id>.
2018-10-16 11:51:48 -07:00
Yago González
a7c48acc8e
api docs: Document GET /realm/filters.
2018-10-16 11:51:48 -07:00
Steve Howell
395d74c08a
api docs: Clean up outgoing webhooks section.
...
I rewrote the section explaining what the
endpoint sends back to the server. This fixes
a few typos, emphasizes the normal case, and
starts to favor "content" as the key for
content.
2018-10-11 16:12:07 -07:00
Tim Abbott
83bcea3917
api: Fix docs to point to /latest/ for integration docs.
...
Pointing to /stable/ doesn't work, since that article doesn't exist in
the 1.8.0 release series.
2018-10-10 12:19:14 -07:00
Rishi Gupta
bf22eefede
api docs: Move integration-docs-guide to docs/.
2018-10-09 20:28:44 -07:00
Callum Fraser
383f1633e6
api: Add limit of total messages available per request of 5000.
...
Tweaked by tabbott to use a declared constant rather than just use
5000 in multiple places; this also means we can change the count
without updating translations.
Fixes #10446 .
2018-10-09 15:43:21 -07:00
Tim Abbott
a943e55863
docs: Move LDAP documentation out of plug-and-play section.
...
Also update the links to this section.
2018-09-27 13:38:14 -07:00
Rishi Gupta
7f16d27015
api docs: Update api-keys.
2018-09-25 21:02:58 -07:00
Rishi Gupta
78f8fac106
api docs: Make minor copyediting changes.
2018-09-25 20:48:12 -07:00
Eeshan Garg
0817905480
api docs: Use Markdown extension for tabbed sections.
2018-09-18 13:49:34 -07:00
Yago González
ea10f5eb2c
api docs: Document GET /users/<email>/presence.
...
Tweaked by tabbott to describe more clearly what this is for.
2018-08-31 15:15:54 -07:00
Yago González
78f85ef960
api docs: Document the GET /messages/<message_id>/history endpoint.
2018-08-28 17:33:02 -07:00
Yago González
5c6f381f32
api docs: Document the DELETE /messages/<message_id> endpoint.
2018-08-28 17:26:49 -07:00
Yago González
9575f1b51f
api docs: Document the GET /messages/<message_id> endpoint.
2018-08-28 17:22:28 -07:00
Yago González
ab164ba740
api docs: Document the GET /messages endpoint.
2018-08-28 17:17:46 -07:00
Yago González
c36cf95dc8
api docs: Document GET /server_settings.
2018-08-27 17:45:50 -07:00
Tim Abbott
0af7a12197
api: Fix typos in doc on constructing narrows.
2018-08-27 17:37:37 -07:00
Lyla Fischer
1efcdfdb5c
templates: Merge Help and API doc main into documentation_main.
...
With minor fixes by eeshangarg.
2018-08-27 20:19:24 -02:30
Yago González
54464feda7
api docs: Document the PATCH /users/me/subscriptions/muted_topics endpoint.
2018-08-26 23:10:21 -07:00
Yago González
e7c7b19507
api docs: Document POST /realm/filters.
2018-08-22 17:42:14 -07:00
Yago González
fcf1e3cd88
api docs: Add guide for creating narrows.
...
Dramatically edited by tabbott to simplify the discussion and
duplication of content in our main search documentation.
2018-08-22 17:16:27 -07:00
Yago González
aa5185fdf8
api docs: Document POST /typing.
2018-08-17 12:57:40 -07:00
Rishi Gupta
e7374a0852
api docs: Link to our zapier and ifttt /integrations pages.
2018-08-10 10:37:49 -07:00
Yago González
90e3b8d808
api docs: Remove unnecessary argument entry.
2018-08-08 09:29:27 -07:00
Yago González
8d0cf3ebe5
api docs: Migrate POST /user_uploads to OpenAPI.
2018-08-08 09:29:27 -07:00
Yago González
119b3c0bc4
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-08-08 09:29:27 -07:00
Yago González
14c9277095
api docs: Migrate POST /users to OpenAPI.
2018-08-08 09:29:27 -07:00