AIL/ail-framework
7
0
Fork 0
mirror of https://github.com/ail-project/ail-framework.git synced 2024-11-10 08:38:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: [api] fix documentation errors output

Browse source
This commit is contained in:
Terrtia 2019-07-31 11:19:06 +02:00
commit 79ad809d2c
No known key found for this signature in database
GPG key ID: 1E1B1F50D84613D0
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/README.md
View file

@ -4,12 +4,12 @@
### Automation key ### 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: The authorization is performed by using the following header:
~~~~ ~~~~
Authorization: YOUR API KEY Authorization: YOUR_API_KEY
~~~~ ~~~~
### Accept and Content-Type headers ### Accept and Content-Type headers
@ -22,7 +22,7 @@ Content-Type: application/json
Example: Example:
~~~~ ~~~~
curl --header "Authorization: YOUR API KEY" --header "Content-Type: application/json" https://<AIL URL>/ curl --header "Authorization: YOUR_API_KEY" --header "Content-Type: application/json" https://AIL_URL/
~~~~ ~~~~
## Item management ## Item management
@ -460,5 +460,5 @@ curl -k https://127.0.0.1:7000/api/import/item/b20a69f1-99ad-4cb3-b212-7ce24b763
```json ```json
{"status": "error", "reason": "Invalid uuid"} {"status": "error", "reason": "Invalid uuid"}
{"status": "error", "reason": "Unknow uuid"} {"status": "error", "reason": "Unknown uuid"}
``` ```