Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/sidebar.md

32 lines
749 B
Markdown
Raw Normal View History

/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: 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)
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
#### Messages
* [Stream message](/api/stream-message)
* [Private message](/api/private-message)
api: Fill out the sidebar with sections. Most of these should be migrated from ReadTheDocs to this new site.
2017-11-08 22:15:41 +01:00
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
#### Streams
* [Get all streams](/api/get-all-streams)
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
* [Get stream ID](/api/get-stream-id)
api docs: Document the GET /users/me/subscriptions endpoint.
2017-12-30 01:19:43 +01:00
* [Get subscribed streams](/api/get-subscribed-streams)
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api: Fill out the sidebar with sections. Most of these should be migrated from ReadTheDocs to this new site.
2017-11-08 22:15:41 +01:00
## Integrations
docs: Move integration docs to /api.
2017-11-16 17:36:52 +01:00
* [Overview](/api/integration-guide)
api: Fill out the sidebar with sections. Most of these should be migrated from ReadTheDocs to this new site.
2017-11-08 22:15:41 +01:00
* [Existing integrations](/integrations)
## Writing webhook integrations
docs: Move integration docs to /api.
2017-11-16 17:36:52 +01:00
* [Overview](/api/integration-guide#webhook-integrations)
* [Walkthrough](/api/webhook-walkthrough)
* [Documenting integrations](/api/integration-docs-guide)
api: Fill out the sidebar with sections. Most of these should be migrated from ReadTheDocs to this new site.
2017-11-08 22:15:41 +01:00
## Interactive bots (experimental)
docs: Move bot docs to /api. With a few fixes for rendering bugs. The rest will be in a follow-up issue.
2017-11-15 11:49:15 +01:00
* [Running bots](/api/running-bots)
* [Writing bots](/api/writing-bots)