From fd406759dda9bc023e436c3f0653fb5b1b77d8e5 Mon Sep 17 00:00:00 2001 From: Christian Hofmaier Date: Sun, 29 Mar 2020 15:47:39 +0000 Subject: [documentation/en] some lang fixes --- documentation/api/README.md | 16 ++++++++-------- documentation/api/collections.md | 6 +++--- 2 files changed, 11 insertions(+), 11 deletions(-) (limited to 'documentation/api') diff --git a/documentation/api/README.md b/documentation/api/README.md index d1e88e3..c617844 100644 --- a/documentation/api/README.md +++ b/documentation/api/README.md @@ -1,21 +1,21 @@ # Getting Started -The Api can be called under the following address: +The API can be called under the following address: ``` https:///api/ ``` The collections and resources are described in the [Collections](/api/collections.md) section. ## Authorization -Some collections need authentication while other can be called without. -To authenticate a request you have to send the json web token to the backend.\ -There are two way to do so +Some collections need authentication while others can be called without. +To authenticate a request you have to send the JSON web token to the backend.\ +There are two ways to do so * **Authorization Header**\ Set the *Bearer* token in the *Authorization* header. ``` Authorization: Bearer ``` -> **\** - Full json web token in the form header.payload.signature. +> **\** - Full JSON web token in form of header.payload.signature. * **Cookies**\ To prevent that the Javascript code of the website has access to the full jwt the token is splitted in two seperate cookies. @@ -25,12 +25,12 @@ To prevent that the Javascript code of the website has access to the full jwt th To get the token use the login method from the [api/authentication](/api/collections.html#authentication). ## Return values -The API returns data always in JSON format. +The API always returns data in JSON format. If the request was successfull it will return status code 200 and the requested data. * [200 - OK](https://httpstatuses.com/200)\ -Request was successfull. Optional the response has an json object with the data included. +Request was successfull. Optional the response has a JSON object with the data included. -If a request is not successfull it will set a html status code and return a json object with a status and an error message included. +If a request is not successfull it will set a HTML status code and return a JSON object with a status and an error message included. ```json { "error": "", diff --git a/documentation/api/collections.md b/documentation/api/collections.md index ebfed8c..b79dbed 100644 --- a/documentation/api/collections.md +++ b/documentation/api/collections.md @@ -1,5 +1,5 @@ # Collections -Collections can be called with the api url appended with the collection and resource name. +Collections can be called with the API URL appended with the collection and resource name. ``` https:///api// ``` @@ -14,7 +14,7 @@ https:///api/authentication/ ``` ### Token Login -Login method to get a json web token (jwt) for the Authorization header, to make authenticated api calls. +Login method to get a JSON web token (jwt) for the Authorization header, to make authenticated API calls. **Request** ```json @@ -100,7 +100,7 @@ https:///api/authentication/logout ## Setup ### Status -Returns wheather the unauthorized user (root account) creation can be executed. +Returns whether the unauthorized user (root account) creation can be executed. **Request** ``` -- cgit v1.2.3-55-g7522