From 0e6f337e15e9a5d7fec6b14f33e7dbc24691fd36 Mon Sep 17 00:00:00 2001 From: Sascha Rommelfangen Date: Tue, 30 Jul 2019 14:15:01 +0200 Subject: [PATCH 1/2] consistency and wording --- doc/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 44613c26..b1477dc6 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,12 +4,12 @@ ### Automation key -The authentication of the automation is performed via a secure key available in the AIL UI interface. Make sure you keep that key secret as it gives access to the entire database! The API key is available in the ``Server Management`` menu under ``My Profile``. +The authentication of the automation is performed via a secure key available in the AIL UI interface. Make sure you keep that key secret. It gives access to the entire database! The API key is available in the ``Server Management`` menu under ``My Profile``. The authorization is performed by using the following header: ~~~~ -Authorization: YOUR API KEY +Authorization: YOUR_API_KEY ~~~~ ### Accept and Content-Type headers @@ -22,7 +22,7 @@ Content-Type: application/json Example: ~~~~ -curl --header "Authorization: YOUR API KEY" --header "Content-Type: application/json" https:/// +curl --header "Authorization: YOUR_API_KEY" --header "Content-Type: application/json" https://AIL_URL/ ~~~~ ## Item management From ced2e3bfe98b720ed33fe7a8b899026e6a422b87 Mon Sep 17 00:00:00 2001 From: Sascha Rommelfangen Date: Tue, 30 Jul 2019 14:23:37 +0200 Subject: [PATCH 2/2] so many spelling mistakes have been corrected in this commit. It's totally worth writing so much explanation... --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index b1477dc6..bc1eb7c1 100644 --- a/doc/README.md +++ b/doc/README.md @@ -460,5 +460,5 @@ curl -k https://127.0.0.1:7000/api/import/item/b20a69f1-99ad-4cb3-b212-7ce24b763 ``` {'status': 'error', 'reason': 'Invalid uuid'} - {'status': 'error', 'reason': 'Unknow uuid'} + {'status': 'error', 'reason': 'Unknown uuid'} ```