rest api docs (issue #4) #34
Conversation
| * POST /api/logout - close session | ||
| * GET /api/token - verifies whether auth token is still valid | ||
|
|
||
| # Users |
There was a problem hiding this comment.
Maybe create separate methods for user administration?
For instance, give or remove permissions to manage teams.
There was a problem hiding this comment.
Good idea, lets add that when it was needed in client applications.
| @@ -0,0 +1,40 @@ | |||
| Short API doc. | |||
|
|
|||
| # Authentication | |||
There was a problem hiding this comment.
Since we decided to develop a telegram bot, we need a way to authorize a telegram user. Does it make sense to create methods to grant and revoke access for a telegram user by token?
There was a problem hiding this comment.
Any improvement makes sence :), but now this API is for MVP version only. We could extend it on demand, no need to design it carefully right now.
There was a problem hiding this comment.
I agree, we have an issue #42 for this.
|
|
||
| ## Calendar Events Collection [/api/calendar/{id}/events] | ||
|
|
||
| ### Retreive calendar events [GET] |
There was a problem hiding this comment.
Also, it would be useful to have a separate API method for search on the calendar (by date, creator, type, or description).
There was a problem hiding this comment.
Yes, search or filters are useful. Lets add them on demand.
PR for issue #4.
TODO