docs: add error handling section to version 1

This commit is contained in:
Stevan Freeborn
2023-04-22 15:53:41 -05:00
parent 46d0db60c9
commit d1fe5d43ce
3 changed files with 59 additions and 0 deletions
@@ -0,0 +1,26 @@
# Error Code Summary
{% code heading="ERROR CODES" defaultLanguage="text" %}
```text
400 Bad Request - The request was unacceptable, often due to missing a required parameter.
401 Unauthorized - No valid API key provided.
403 Forbidden - The API key doesn't have permissions to perform the request.
404 Not Found - The requested resource doesn't exist.
499 Client Closed Request - Our API gateway closed the connection because the request exceeded the 90 second timeout limit.
5xx Server Errors - Something went wrong on Onspring's end.
```
{% /code %}
# The Error Object
{% code heading="ERROR OBJECT" defaultLanguage="json" %}
```json
{
"Message": "Client does not have access to read app: 1"
}
```
{% /code %}