octycseu/keytracker
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add global Readme and update server Readme

Browse source
This commit is contained in:
octycs 2020-03-18 18:33:39 +01:00
parent d35cc5eda2
commit 0a124c3e7b
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Readme.md Normal file
View file

@ -0,0 +1,4 @@
This repo bundles all parts of the keytracker project:
- `server`: The keytracker backend that provides the API
- `frontend`: The web frontend for the keytracker
- `telegram`: The Telegram Bot (which also uses the API)

4
server/Readme.md
View file

@ -19,7 +19,7 @@ The token and history remain in the database and can still be used, however it i
to retrieve the key name and get a new auth token to query the keyholder. to retrieve the key name and get a new auth token to query the keyholder.
Changing the key name does also automatically update as the key name is not stored in the database. Changing the key name does also automatically update as the key name is not stored in the database.
The same applies for the password. Note that when the password is changed all users that already The same applies for the password. Note that when the password is changed all users that already
have access to the keyholder data keep their access (The auth token remain valid) have access to the keyholder data keep their access (The auth token remain valid).
Changing the key id is equivalent to adding a new key and deleting the old key. Changing the key id is equivalent to adding a new key and deleting the old key.
Changing the claim token will automatically add the new token to the database, however the old token Changing the claim token will automatically add the new token to the database, however the old token
will not automatically be invalidated. To invalidate the old key (e.g. to invalidate a QR code), will not automatically be invalidated. To invalidate the old key (e.g. to invalidate a QR code),
@ -44,7 +44,7 @@ Return up to 3 of the latest keyholder as JSON list (first element is the curren
`[{"name": "<Name>", "contact": "<Contact>", "timestamp": <unix timestamp>}, ...]`. `[{"name": "<Name>", "contact": "<Contact>", "timestamp": <unix timestamp>}, ...]`.
If the auth token is not allowed to query the keyholder a 403 error is returned. If the auth token is not allowed to query the keyholder a 403 error is returned.
*/status/<claim id>* (GET) */status/\<claim id\>* (GET)
Query whether the given claim is still the latest. This is the only request that does not require a token. Query whether the given claim is still the latest. This is the only request that does not require a token.
It may return the following values: It may return the following values:
`unknown` - the claim id is unknown `unknown` - the claim id is unknown