From 78f8fac10645eaf43553a7e53981d779c6135102 Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 25 Sep 2018 19:28:29 -0700 Subject: [PATCH] api docs: Make minor copyediting changes. --- templates/zerver/api/configuring-python-bindings.md | 3 +-- templates/zerver/api/installation-instructions.md | 2 +- templates/zerver/api/rest-error-handling.md | 4 ++-- templates/zerver/api/rest.md | 5 +++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/templates/zerver/api/configuring-python-bindings.md b/templates/zerver/api/configuring-python-bindings.md index 27a0416afa..81a97a73d1 100644 --- a/templates/zerver/api/configuring-python-bindings.md +++ b/templates/zerver/api/configuring-python-bindings.md @@ -13,8 +13,7 @@ settings. There are two ways to achieve that: [environment variables](https://en.wikipedia.org/wiki/Environment_variable) set up in your host machine. -A `.zuliprc` file is a plain text document that has the same format as -Microsft Windows INI files. It looks like this: +A `.zuliprc` file is a plain text document that looks like this: ``` [api] diff --git a/templates/zerver/api/installation-instructions.md b/templates/zerver/api/installation-instructions.md index 799c93ce2e..eb74262722 100644 --- a/templates/zerver/api/installation-instructions.md +++ b/templates/zerver/api/installation-instructions.md @@ -1,7 +1,7 @@ # Installation instructions 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 writing interactive bots that react to messages), so we recommend it diff --git a/templates/zerver/api/rest-error-handling.md b/templates/zerver/api/rest-error-handling.md index 64b1ba1961..2b99d875ed 100644 --- a/templates/zerver/api/rest-error-handling.md +++ b/templates/zerver/api/rest-error-handling.md @@ -1,7 +1,7 @@ # Error Handling -Zulip's API will always return a JSON format response. Like any good -API, the HTTP status code indicates whether the request was successful +Zulip's API will always return a JSON format response. +The HTTP status code indicates whether the request was successful (200 = success, 40x = user error, 50x = server error). Every response will contain at least two keys: `msg` (a human-readable error message) and `result`, which will be either `error` or `success` (this is diff --git a/templates/zerver/api/rest.md b/templates/zerver/api/rest.md index 30a46bcd90..cfc5f6c451 100644 --- a/templates/zerver/api/rest.md +++ b/templates/zerver/api/rest.md @@ -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'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). * Choose what language you'd like to use. You can download the [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 appropriate HTTP Basic Authentication headers; see each endpoint's `curl` option for details on the request format.