summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorUdo Walter2019-03-30 23:12:26 +0100
committerUdo Walter2019-03-30 23:12:26 +0100
commit14b2f82c72f153f55f861f6700ba9ce2ccf5fa52 (patch)
tree9bcfbe7f7892853c51e332321221d9dd7bd6f208 /documentation
parent[server] configurator api -> ipxeconfigs and ipxeentries api; [webapp] ui pol... (diff)
downloadbas-14b2f82c72f153f55f861f6700ba9ce2ccf5fa52.tar.gz
bas-14b2f82c72f153f55f861f6700ba9ce2ccf5fa52.tar.xz
bas-14b2f82c72f153f55f861f6700ba9ce2ccf5fa52.zip
[docs] small text changes
Diffstat (limited to 'documentation')
-rw-r--r--documentation/api/README.md18
-rw-r--r--documentation/de/api/README.md20
2 files changed, 13 insertions, 25 deletions
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.
diff --git a/documentation/de/api/README.md b/documentation/de/api/README.md
index cda83b4..656172a 100644
--- a/documentation/de/api/README.md
+++ b/documentation/de/api/README.md
@@ -7,7 +7,7 @@ Die Sammlungen und Ressourcen werden im Abschnitt [Sammlungen](/de/api/collectio
## Autorisierung
Einige Sammlungen benötigen eine Authentifizierung, während andere ohne aufgerufen werden können.
-Um eine Anfrage zu authentifizieren, müssen Sie den Json-Web-Token an das Backend senden.
+Um eine Anfrage zu authentifizieren, müssen Sie den Json-Web-Token an das Backend senden.
Es gibt zwei Möglichkeiten, dies zu tun
* **Authorization Header**\
Durch setzen des *Bearer* token im *Authorization* header.
@@ -38,20 +38,14 @@ Wenn eine Anforderung nicht erfolgreich ist, setzt sie einen HTML-Statuscode und
}
```
* [400 - Bad Request](https://httpstatuses.com/400)\
-Die an den Server gesendete Anfrage war ungültig. (Parameter fehlt, ...)
+Die Anfrage war ungültig. (z.B. fehlende Parameter)
* [401 - Unauthorized](https://httpstatuses.com/401)\
-Der Client, der die Anfrage an den Server gesendet hat, war nicht ausreichend autorisiert. (Ungültiger Token, Token fehlt, ...)
+Die Anfrage war nicht richtig autorisiert. (z.B. ungültiger Token, fehlender Token)
* [403 - Forbidden](https://httpstatuses.com/403)\
-Der autorisierte Client verfügt nicht über ausreichende Berechtigungen.
+Der Benutzer hat nicht die benötigten Rechte.
* [404 - Not Found](https://httpstatuses.com/404)\
-Die angeforderte Ressource wurde nicht gefunden. (Benutzer wurde nicht gefunden, ...)
+Die angeforderte Ressource wurde nicht gefunden.
* [500 - Internal Server Error](https://httpstatuses.com/500)\
-Serverseitiger Fehler. (Hash-Fehler, ...)
+Ein serverseitiger Fehler ist aufgetreten.
* [501 - Not Implemented](https://httpstatuses.com/501)\
-Die Ressource verfügt nicht über die angeforderten Methoden. (Das Backend hat die Methode nicht implementiert)
-
-Wenn eine Anfrage, die eine Authentifizierung benötigt, nicht hinreichend Authentifiziert ist, können folgende Fehler auftreten
-* **401 - Unauthorized**
- * TOKEN\_INVALID - Der angegebene Token ist ungültig.
- * TOKEN\_INVALID - Der Token stammt von einer ungültigen Benutzer-ID.
- * TOKEN\_MISSING - Dieser Dienst erfordert einen Token.
+Der API Endknoten ist nicht implementiert.