aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTrumeet <yuuta@yuuta.moe>2022-07-13 12:48:54 -0700
committerTrumeet <yuuta@yuuta.moe>2022-07-13 12:48:54 -0700
commit4a6706a4a03108008b8859b59b85af83f0182862 (patch)
treeaef4eb57e4846f75da30c6ceb28b9d8f308d47b4
parent39352c6ecc154bac07ac6f6d4ca9abea09fa9db3 (diff)
downloadacron-4a6706a4a03108008b8859b59b85af83f0182862.tar
acron-4a6706a4a03108008b8859b59b85af83f0182862.tar.gz
acron-4a6706a4a03108008b8859b59b85af83f0182862.tar.bz2
acron-4a6706a4a03108008b8859b59b85af83f0182862.zip
Explain global error codes (400 and 500) in docs
Signed-off-by: Trumeet <yuuta@yuuta.moe>
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6d952cb..3a6f81e 100644
--- a/README.md
+++ b/README.md
@@ -229,6 +229,11 @@ 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.
+Global error codes:
+
+* 400: The request is invalid.
+* 500: The server encountered an unknown error.
+
**`.type` and `.id` are included in every request / response, except for further noticed. Thus,
this document excludes them from the parameter lists.**