Updated README
parent
236ed765e2
commit
156a0ed950
14
README.md
14
README.md
|
@ -4,6 +4,8 @@ Beep backend handling user permissions. Currently, permissions are defined as us
|
||||||
|
|
||||||
Relations are cached in redis to avoid excessive querying time. A listener updates the cache on database changes.
|
Relations are cached in redis to avoid excessive querying time. A listener updates the cache on database changes.
|
||||||
|
|
||||||
|
This service is meant to be used internally. Otherwise, people can systematically query it finding out which conversation a said user is in.
|
||||||
|
|
||||||
## Environment variables
|
## Environment variables
|
||||||
|
|
||||||
Supply environment variables by either exporting them or editing `.env`.
|
Supply environment variables by either exporting them or editing `.env`.
|
||||||
|
@ -32,8 +34,20 @@ Query to see if userid-conversationid is permissable.
|
||||||
|
|
||||||
#### Params
|
#### Params
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | ---- | ----------- |
|
||||||
|
| userid | String | User's ID |
|
||||||
|
| conversationid | Conversation ID |
|
||||||
|
|
||||||
#### Success (200 OK)
|
#### Success (200 OK)
|
||||||
|
|
||||||
Empty body.
|
Empty body.
|
||||||
|
|
||||||
#### Errors
|
#### Errors
|
||||||
|
|
||||||
|
It is recommended to intrepet both as a rejection regardless of error type.
|
||||||
|
|
||||||
|
| Code | Description |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| 401 | Matching userid-conversationid pair not found |
|
||||||
|
| 500 | Error accessing cache |
|
||||||
|
|
Loading…
Reference in New Issue