From ec1faad4ab8b4e050fef340e784958ff6ed479af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Tue, 6 Nov 2018 19:41:44 +0100 Subject: [PATCH] Add note about bad request response MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- docs/API.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/API.md b/docs/API.md index ddb792715..dc0a11759 100644 --- a/docs/API.md +++ b/docs/API.md @@ -18,6 +18,17 @@ The REST API provides access for authenticated users to their data inside the De ## Global responses +### 400 Bad request + +In case the request is invalid, e.g. because a parameter is missing, a 400 error will be returned: + +```json +{ + "status": 400, + "message": "title must be provided" +} +``` + ### 403 Permission denied In any case a user doesn't have access to a requested entity, a 403 error will be returned: