From 4a6706a4a03108008b8859b59b85af83f0182862 Mon Sep 17 00:00:00 2001 From: Trumeet Date: Wed, 13 Jul 2022 12:48:54 -0700 Subject: Explain global error codes (400 and 500) in docs Signed-off-by: Trumeet --- README.md | 5 +++++ 1 file changed, 5 insertions(+) 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.** -- cgit v1.2.3