diff --git a/dist/templates/about/api.html.hbs b/dist/templates/about/api.html.hbs index 1d1cefa..c79fd06 100644 --- a/dist/templates/about/api.html.hbs +++ b/dist/templates/about/api.html.hbs @@ -145,12 +145,38 @@ "token": "..." } -
+ If a request fails for any reason,
+ a suitable HTTP status code will be returned.
+ In this case,
+ the response body will be
+ a JSON object
+ with a single error
attribute.
+ A request may fail
+ with an error code of 503
+ at any time
+ if the server is undergoing
+ database maintenance.
+ For this reason,
+ clients should handle 503 errors gracefully.
+
+{ + "error": "We are currently undergoing scheduled database maintenance!", +} ++
Hagrid implements a subset of