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

api docs: Make minor copyediting changes.

This commit is contained in:
Rishi Gupta 2018-09-25 19:28:29 -07:00
parent 8c6424a4bd
commit 78f8fac106
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
templates/zerver/api/configuring-python-bindings.md
View File

@ -13,8 +13,7 @@ settings. There are two ways to achieve that:
[environment variables](https://en.wikipedia.org/wiki/Environment_variable) [environment variables](https://en.wikipedia.org/wiki/Environment_variable)
set up in your host machine. set up in your host machine.
A `.zuliprc` file is a plain text document that has the same format as A `.zuliprc` file is a plain text document that looks like this:
Microsft Windows INI files. It looks like this:
``` ```
[api] [api]

2
templates/zerver/api/installation-instructions.md
View File

@ -1,7 +1,7 @@
# Installation instructions # Installation instructions
Zulip's REST API is easy to work with directly, but there are API Zulip's REST API is easy to work with directly, but there are API
libraries available for various popular languages. libraries available for a few popular languages.
The Python library is the most advanced (and has tools for easily The Python library is the most advanced (and has tools for easily
writing interactive bots that react to messages), so we recommend it writing interactive bots that react to messages), so we recommend it

4
templates/zerver/api/rest-error-handling.md
View File

@ -1,7 +1,7 @@
# Error Handling # Error Handling
Zulip's API will always return a JSON format response. Like any good Zulip's API will always return a JSON format response.
API, the HTTP status code indicates whether the request was successful The HTTP status code indicates whether the request was successful
(200 = success, 40x = user error, 50x = server error). Every response (200 = success, 40x = user error, 50x = server error). Every response
will contain at least two keys: `msg` (a human-readable error message) will contain at least two keys: `msg` (a human-readable error message)
and `result`, which will be either `error` or `success` (this is and `result`, which will be either `error` or `success` (this is

5
templates/zerver/api/rest.md
View File

@ -4,11 +4,12 @@ The Zulip REST API powers the Zulip web and mobile apps, so anything
you can do in Zulip, you can do with Zulip's REST API. To use this API: you can do in Zulip, you can do with Zulip's REST API. To use this API:
* You'll need to [get an API key](/api/api-keys). You will likely * You'll need to [get an API key](/api/api-keys). You will likely
want to create a bot, unless you're using the API to interact with want to [create a bot](/help/add-a-bot-or-integration), unless you're
using the API to interact with
your own account (e.g. exporting your personal message history). your own account (e.g. exporting your personal message history).
* Choose what language you'd like to use. You can download the * Choose what language you'd like to use. You can download the
[Python or JavaScript bindings](/api/installation-instructions), or [Python or JavaScript bindings](/api/installation-instructions), or
just make HTTP request with your favorite programming language. If just make HTTP requests with your favorite programming language. If
you're making your own HTTP requests, you'll want to send the you're making your own HTTP requests, you'll want to send the
appropriate HTTP Basic Authentication headers; see each endpoint's appropriate HTTP Basic Authentication headers; see each endpoint's
`curl` option for details on the request format. `curl` option for details on the request format.