diff --git a/dist/templates/about/api.html.hbs b/dist/templates/about/api.html.hbs index c79fd06..dbabd33 100644 --- a/dist/templates/about/api.html.hbs +++ b/dist/templates/about/api.html.hbs @@ -145,25 +145,31 @@ "token": "..." } +
- If a request fails for any reason, + If a GET request fails for any reason, a suitable HTTP status code will be returned. - In this case, - the response body will be + The response will be a plaintext error message. + If a key is not found, + the HTTP status code will be 404. +
+
+ If a POST request fails for any reason,
+ a suitable HTTP status code will be returned.
+ The response body will be
a JSON object
with a single error
attribute.
- A request may fail
- with an error code of 503
+ A POST request may fail
+ with a HTTP 503 error
at any time
if the server is undergoing
database maintenance.
- For this reason,
- clients should handle 503 errors gracefully.
+ Clients should handle errors gracefully for POST requests.
{ - "error": "We are currently undergoing scheduled database maintenance!", + "error": "We are currently undergoing scheduled database maintenance!" }