From 14b2f82c72f153f55f861f6700ba9ce2ccf5fa52 Mon Sep 17 00:00:00 2001 From: Udo Walter Date: Sat, 30 Mar 2019 22:12:26 +0000 Subject: [docs] small text changes --- documentation/api/README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) (limited to 'documentation/api') diff --git a/documentation/api/README.md b/documentation/api/README.md index 7f6dc66..d1e88e3 100644 --- a/documentation/api/README.md +++ b/documentation/api/README.md @@ -38,20 +38,14 @@ If a request is not successfull it will set a html status code and return a json } ``` * [400 - Bad Request](https://httpstatuses.com/400)\ -The request sent to the server was invalid. (Parameter missing, ...) +The request was invalid. (e.g. parameter missing) * [401 - Unauthorized](https://httpstatuses.com/401)\ -The client which sent the request to the server wasn't authorized enough. (Invalid token, token missing, ...) +The request was not properly authorized. (e.g. token invalid, token missing) * [403 - Forbidden](https://httpstatuses.com/403)\ -The authorized client doesn't have enough permission. +The user does not have the required permissions. * [404 - Not Found](https://httpstatuses.com/404)\ -The requested resource was not found. (User not found, ...) +The requested resource was not found. * [500 - Internal Server Error](https://httpstatuses.com/500)\ -Server side error. (Hash errors, ...) +A server-side error occurred. * [501 - Not Implemented](https://httpstatuses.com/501)\ -The resource doesn't have the requested methods. (Backend doesn't have the method implemented) - -If a request that requires authentication isn't properly authenticated one of the following erros can occur -* **401 - Unauthorized** - * TOKEN\_INVALID - The provided token is invalid. - * TOKEN\_INVALID - The token is from an invalid userid. - * TOKEN\_MISSING - This service requires a token. +The API endpoint is not implemented. -- cgit v1.2.3-55-g7522