Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/api_docs/sidebar_index.md

30 lines
970 B
Markdown
Raw Normal View History

api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
## Integrations
api docs: Restructure integrations section and add an overview.
2018-10-12 01:12:16 +02:00
* [Overview](/api/integrations-overview)
* [Incoming webhook integrations](/api/incoming-webhooks-overview)
api docs: Rename webhook-walkthrough to incoming-webhooks-walkthrough.
2018-10-17 05:08:27 +02:00
* [Hello world walkthrough](/api/incoming-webhooks-walkthrough)
api docs: Rename integration-guide.md to non-webhook-integrations.md.
2018-10-17 05:01:59 +02:00
* [Non-webhook integrations](/api/non-webhook-integrations)
api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
## Interactive bots (beta)
api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
* [Running bots](/api/running-bots)
docs: Add a page on deploying bots in production.
2018-05-19 01:12:18 +02:00
* [Deploying bots](/api/deploying-bots)
api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
* [Writing bots](/api/writing-bots)
docs: Add documentation for outgoing webhooks. Rewritten by some combination of @rheaparekh and @timabbott to more clearly discuss what's actually important to users.
2017-07-19 06:16:27 +02:00
* [Outgoing webhooks](/api/outgoing-webhooks)
api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
/api/: Fix some headings.
2017-11-08 22:08:23 +01:00
## REST API
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
/api: Add an overview doc for the REST API.
2018-04-17 00:41:30 +02:00
* [Overview](/api/rest)
api: Migrate to using the new version of the API site.
2017-11-11 02:49:43 +01:00
* [Installation instructions](/api/installation-instructions)
* [API keys](/api/api-keys)
docs: Explain how to configure the Python bindings. The Python bindings (which are used for bots, amongst other things) can be configured either with a .zuliprc file or with environment variables in the host machine. This new page in the user docs explains how to set the bindings up using both techniques, and is a good reference on the setup required by Zulip bots.
2018-05-13 21:02:41 +02:00
* [Configuring the Python bindings](/api/configuring-python-bindings)
api_docs: Add page documenting HTTP headers in the api docs. Adds a page to the general api documentation about HTTP headers, so that information about the special response headers for rate limits have a more logical location in the docs and so that other HTTP header information can be shared, such as `User-Agent` conventions. Adjusts some text and linking on the rest-error-handling page and overview page for the REST API for the addition of the HTTP headers page.
2022-01-24 16:55:05 +01:00
* [HTTP headers](/api/http-headers)
docs: Rename rest_error_handling with dashes.
2018-05-05 23:25:02 +02:00
* [Error handling](/api/rest-error-handling)
api_docs: Add roles and permissions page to API documentation. Adds a non-endpoint specific page to the API documentation about organization-level roles and permissions for users in order to highlight important and useful information for clients and API users. Also, adds links to new documentation page in related areas of the API documentation.
2022-03-29 21:11:59 +02:00
* [Roles and permissions](/api/roles-and-permissions)
groups: Pass old setting value for can_mention_group. This commit adds support to pass object containing both old and new values of the can_mention_group setting, as well as detailed API documentation for this part of the API system. Co-authored-by: Tim Abbott <tabbott@zulip.com> Co-authored-by: Greg PRice <greg@zulip.com>
2024-05-02 15:52:23 +02:00
* [Group-setting values](/api/group-setting-values)
api-docs: Add article about markup message formatting. Adds a "Message formatting" article to the API documentation. To start, the article is a changelog of updates to markup features for messages, with the idea being that it can be expanded to further describe and document Zulip's markup features in future iterations.
2024-04-03 20:37:14 +02:00
* [Message formatting](/api/message-formatting)
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
* [Client libraries](/api/client-libraries)
api docs: Fix API changelog capitalization. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-10-01 22:34:17 +02:00
* [API changelog](/api/changelog)
api docs: Split usage.md into two separate docs. This commit splits usage.md into two separate docs, stream-message.md and private-message.md. The arguments and return values for sending a stream message are somewhat different from those of sending a private message, so it made sense to split the two up for clarity.
2017-12-22 02:24:30 +01:00
docs: Rename rest_endpoints with dashes.
2018-05-14 15:40:24 +02:00
{!rest-endpoints.md!}