Merge pull request #53 from pelias/http_status_codes

documentation for http status codes

http-status-codes.md

@@ -0,0 +1,19 @@
+# HTTP status codes
+
+## Geocoding
+
+The following status codes are returned from the geocoding service:
+
+- `200 OK`: The request has succeeded.
+- `400 Bad Request`: An input parameter was invalid. An error message is included in the response body with more details.
+- `404 Not Found`: The URL is invalid or the path is no longer valid.
+- `408 Request Timeout`: The Elasticsearch cluster took too long to respond.
+- `500 Internal Server Error`: Generic fatal error.
+- `502 Bad Gateway`: Connection was lost to the Elasticsearch cluster.
+
+In all cases above, the response body will be valid geoJSON.
+
+## Rate limiter
+The rate limiter returns the status codes `403 Forbidden` and `429 Too Many Requests`.
+
+See [API keys and rate limits](/api-keys-rate-limits.md) for more information.

index.md

@@ -6,6 +6,7 @@ These pages offer an introduction to the API and terminology used in Mapzen Sear
 
 - [Get started](/get-started.md)
  - [API keys and rate limits](/api-keys-rate-limits.md)
+ - [HTTP status codes](/http-status-codes.md)
  - [`/search` endpoint: finding places](/search.md)
  - [`/autocomplete` endpoint](/autocomplete.md)
  - [`/reverse` endpoint: from point to place](/reverse.md)