aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index c68122f..e1284a6 100644
--- a/README.md
+++ b/README.md
@@ -219,10 +219,16 @@ codes, all faulty WebSocket requests will receive error in the following format:
{
"type": "error",
"id": 1,
+ "code": 500,
"message": "Error message. Not machine-readable."
}
```
+Parameters:
+
+* `.code` (int, HTTP status codes, always present): The machine-readable error code (e. g. 400 for Bad Request).
+* `.message` (string, any, always present): The human-readable error message.
+
**`.type` and `.id` are included in every request / response, except for further noticed. Thus,
this document excludes them from the parameter lists.**