5
0
Fork 0
backend-permissions/README.md

40 lines
971 B
Markdown
Raw Normal View History

2019-06-19 12:17:12 +08:00
# beep-permissions
2019-06-21 11:28:53 +08:00
Beep backend handling user permissions. Currently, permissions are defined as user-scope (i.e. userid in conversationid). If no such pairing exists, permission is denied. Might consider moving to searchms style user-scope-action system later.
2019-06-23 04:07:28 +08:00
Relations are cached in redis to avoid excessive querying time. A listener updates the cache on database changes.
## Environment variables
Supply environment variables by either exporting them or editing `.env`.
| ENV | Description | Default |
| --- | ----------- | ------- |
| LISTEN | Host and port for service to listen on | :80 |
| POSTGRES | URL of postgres | postgresql://root@pg:5432/core?sslmode=disable |
| REDIS | URL of redis | redis:6379 |
## API
| Contents |
| -------- |
| Get Permission |
---
### Get Permission
```
GET /user/:userid/conversation/:conversationid
```
Query to see if userid-conversationid is permissable.
#### Params
#### Success (200 OK)
Empty body.
#### Errors