summaryrefslogtreecommitdiffstats
path: root/documentation/api
diff options
context:
space:
mode:
authorJannik Schönartz2019-03-26 18:12:51 +0100
committerJannik Schönartz2019-03-26 18:12:51 +0100
commite2748fc46cbbae0ee7caf84d92b4a84a23f5783f (patch)
tree55003c866f106f02bb14e98650a30b143d65b79d /documentation/api
parent[webapp/alerts] Fix: Notification didn't fill the whole container when having... (diff)
downloadbas-e2748fc46cbbae0ee7caf84d92b4a84a23f5783f.tar.gz
bas-e2748fc46cbbae0ee7caf84d92b4a84a23f5783f.tar.xz
bas-e2748fc46cbbae0ee7caf84d92b4a84a23f5783f.zip
[docutmentation] Add german language support (wip)
Diffstat (limited to 'documentation/api')
-rw-r--r--documentation/api/README.md4
-rw-r--r--documentation/api/collections.md4
2 files changed, 4 insertions, 4 deletions
diff --git a/documentation/api/README.md b/documentation/api/README.md
index f84cdf5..7f6dc66 100644
--- a/documentation/api/README.md
+++ b/documentation/api/README.md
@@ -38,7 +38,7 @@ 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 incorrect. (Parameter missing, ...)
+The request sent to the server was invalid. (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, ...)
* [403 - Forbidden](https://httpstatuses.com/403)\
@@ -50,7 +50,7 @@ Server side error. (Hash errors, ...)
* [501 - Not Implemented](https://httpstatuses.com/501)\
The resource doesn't have the requested methods. (Backend doesn't have the method implemented)
-If an authenticated request doesn't pass the middleware one of the following error can occur
+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.
diff --git a/documentation/api/collections.md b/documentation/api/collections.md
index b1e85b8..ebfed8c 100644
--- a/documentation/api/collections.md
+++ b/documentation/api/collections.md
@@ -1,7 +1,7 @@
# Collections
-Collections can be called with the api url append with the resource name.
+Collections can be called with the api url appended with the collection and resource name.
```
-https://<domain_bss>/api/<collection>/<resource>
+https://<domain_bas>/api/<collection>/<resource>
```
```
https://<domain_bas>/api/<collection>/:id/<resource>