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

51 lines
1.2 KiB
Markdown
Raw Normal View History

api/sidebar.md: Move "REST API" to the bottom.
2018-01-20 21:50:15 +01:00
## Integrations
* [Overview](/api/integration-guide)
* [Existing integrations](/integrations)
## Writing webhook integrations
* [Overview](/api/integration-guide#webhook-integrations)
* [Walkthrough](/api/webhook-walkthrough)
* [Documenting integrations](/api/integration-docs-guide)
## Interactive bots (experimental)
* [Running bots](/api/running-bots)
* [Writing bots](/api/writing-bots)
/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 docs: Document the POST /api/v1/messages/render endpoint. Note that currently, there is no way to interface with this endpoint using zulip-js.
2017-12-30 02:57:12 +01:00
* [Render message](/api/render-message)
api docs: Document the PATCH /api/v1/messages/<msg_id> endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 23:49:11 +01:00
* [Update a message](/api/update-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 POST /api/v1/users/me/subscriptions endpoint. There is a JavaScript equivalent for this endpoint but the npm package has not yet been released.
2018-01-06 23:49:14 +01:00
* [Add subscriptions](/api/add-subscriptions)
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
* [Remove subscriptions](/api/remove-subscriptions)
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 docs: Document the GET /api/v1/users endpoint.
2017-12-30 04:09:58 +01:00
#### Users
* [Get all users](/api/get-all-users)
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
* [Get profile](/api/get-profile)
api docs: Document the POST /api/v1/users endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-08 19:48:53 +01:00
* [Create a user](/api/create-user)
api docs: Document the GET /api/v1/users endpoint.
2017-12-30 04:09:58 +01:00
api docs: Document the POST /api/v1/register endpoint.
2018-01-03 01:33:30 +01:00
#### Events
* [Register a queue](/api/register-queue)
api docs: Document the GET /api/v1/events endpoint.
2018-01-04 00:07:26 +01:00
* [Get events from queue](/api/get-events-from-queue)
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
* [Delete a queue](/api/delete-queue)
api docs: Add page for common error payloads. We now have a separate page for common error payloads, for example, the payload for when the client's API key is invalid. All error payloads that are presented on this page will be tested similarly to our other non-error sample fixtures.
2018-02-06 21:04:07 +01:00
#### Common Errors
* [Example payloads](/api/common-error-payloads)