Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/cydrobolt/polr.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChaoyi Zha <summermontreal@gmail.com>2017-03-21 00:01:33 +0300
committerChaoyi Zha <summermontreal@gmail.com>2017-03-21 00:01:33 +0300
commitb643906752040b337eff1a91cf0fb7d4ba049e4a (patch)
treec982ea8bf0c6d360ee37feabd7e8116faac34b83 /docs
parent861665f4d778b4d4d675d48ead523f7e769551c9 (diff)
Fix custom ending bug affecting non-truthy endings, update documentation for API error updates
Diffstat (limited to 'docs')
-rw-r--r--docs/developer-guide/api.md6
-rw-r--r--docs/developer-guide/api_errors.md19
2 files changed, 23 insertions, 2 deletions
diff --git a/docs/developer-guide/api.md b/docs/developer-guide/api.md
index c7f854b..b0edd90 100644
--- a/docs/developer-guide/api.md
+++ b/docs/developer-guide/api.md
@@ -218,13 +218,15 @@ This status code is returned in the following circumstances:
Example `json` error response:
```
{
- "error": "custom ending already in use"
+ "status_code":429,
+ "error_code":"QUOTA_EXCEEDED",
+ "error":"Quota exceeded."
}
```
Example `plain_text` error response:
-`custom ending already in use`
+`429 Quota exceeded.`
## Testing the API
diff --git a/docs/developer-guide/api_errors.md b/docs/developer-guide/api_errors.md
new file mode 100644
index 0000000..62f5585
--- /dev/null
+++ b/docs/developer-guide/api_errors.md
@@ -0,0 +1,19 @@
+## API Error Text Codes
+
+`SERVER_ERROR`: A generic, unhandled error has occured.
+
+`JSON_ONLY`: Only JSON-encoded data is available for this endpoint.
+
+`MISSING_PARAMETERS`: Invalid or missing parameters.
+
+`NOT_FOUND`: Object not found.
+
+`ACCESS_DENIED`: User is not authorized to access the object.
+
+`INVALID_ANALYTICS_TYPE`: Invalid analytics type requested.
+
+`CREATION_ERROR`: An error occurred while creating the object.
+
+`AUTH_ERROR`: An error occured while attempting to authenticate the user to the API.
+
+`QUOTA_EXCEEDED`: User's API usage has exceeded alloted quota.