diff --git a/VERSION b/VERSION index cc21297..165e48d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.3.3 +0.3.1 diff --git a/docs/api/auth.md b/docs/api/auth.md index d582559..2617369 100644 --- a/docs/api/auth.md +++ b/docs/api/auth.md @@ -6,7 +6,7 @@ { "username": "string", "password": "string", - "email": "string?" + "email": "string" } ``` @@ -18,7 +18,7 @@ Registers a new user { "id": "string", "username": "string", - "registerDate": "number" + "registerDate": 0 } ``` diff --git a/docs/api/channel.md b/docs/api/channel.md index 0ab4552..465117a 100644 --- a/docs/api/channel.md +++ b/docs/api/channel.md @@ -11,7 +11,7 @@ Returns a channel with id = {id} "id": "string", "name": "string", "communityId": "string", - "creationDate": "number" + "creationDate": 0 } ``` @@ -39,42 +39,3 @@ Creates a new channel and returns it "communityId": "string" } ``` - -## PATCH /api/v1/channel/{id} - -_Requires an authorization header_ - -### Request: - -```json -{ - "name": "string?" -} -``` - -Updates a channel with id = {id} - -### Response: - -```json -{ - "id": "string", - "name": "string", - "communityId": "string" -} -``` - -## DELETE /api/v1/channel/{id} - -_Requires an authorization header_ - -Removes a channel with id = {id} - -### Response: - -```json -{ - "id": "string", - "communityId": "string" -} -``` diff --git a/docs/api/community.md b/docs/api/community.md index 5f260ae..80c4326 100644 --- a/docs/api/community.md +++ b/docs/api/community.md @@ -10,7 +10,7 @@ Returns a community with id = {id} "name": "string", "description": "string", "ownerId": "string", - "creationDate": "number" + "creationDate": 0 } ``` @@ -65,20 +65,6 @@ Updates a community with id = {id} } ``` -## DELETE /api/v1/community/{id} - -_Requires an authorization header_ - -Removes a community with id = {id} - -### Response: - -```json -{ - "id": "string" -} -``` - ## GET /api/v1/community/{id}/members _Requires an authorization header_ diff --git a/docs/api/invite.md b/docs/api/invite.md index 16641f8..b240449 100644 --- a/docs/api/invite.md +++ b/docs/api/invite.md @@ -8,13 +8,13 @@ Returns an invite with id = {id} { "id": "string", "communityId": "string", - "valid": "boolean", - "unlimitedInvites": "boolean", - "hasExpiration": "boolean", - "totalInvites": "number", - "remainingInvites": "number", - "creationDate": "number", - "expirationDate": "number" + "valid": true, + "unlimitedInvites": false, + "hasExpiration": false, + "totalInvites": 0, + "remainingInvites": 0, + "creationDate": 0, + "expirationDate": 0 } ``` diff --git a/docs/api/role.md b/docs/api/role.md index 2e1a51c..ce360ff 100644 --- a/docs/api/role.md +++ b/docs/api/role.md @@ -11,25 +11,7 @@ Returns a role with id = {id} "id": "string", "name": "string", "communityId": "string", - "creationDate": "number" -} -``` - -## GET /api/v1/role/{id}/permissions - -_Requires an authorization header_ - -Returns a role with id = {id} and permissions - -### Response: - -```json -{ - "id": "string", - "name": "string", - "communityId": "string", - "permissions": "string[]". - "creationDate": "number" + "creationDate": 0 } ``` @@ -59,32 +41,6 @@ Creates a new role and returns it } ``` -## PATCH /api/v1/role/{id} - -_Requires an authorization header_ - -### Request: - -```json -{ - "name": "string?", - "permissions": "string[]?" -} -``` - -Updates a role with id = {id} - -### Response: - -```json -{ - "id": "string", - "name": "string", - "communityId": "string", - "permissions": "string[]" -} -``` - ## POST /api/v1/role/{id}/assign _Requires an authorization header_ @@ -134,18 +90,3 @@ Unassigns a role from a user "userId": "string" } ``` - -## DELETE /api/v1/role/{id} - -_Requires an authorization header_ - -Removes a role with id = {id} - -### Response: - -```json -{ - "id": "string", - "communityId": "string" -} -``` diff --git a/docs/api/session.md b/docs/api/session.md index cdbd5be..1b4be61 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -10,7 +10,7 @@ Returns a session with id = {id} { "id": "string", "userId": "string", - "creationDate": "number" + "creationDate": 0 } ``` diff --git a/docs/api/user.md b/docs/api/user.md index 68d2099..6856c59 100644 --- a/docs/api/user.md +++ b/docs/api/user.md @@ -12,39 +12,9 @@ Returns a user with id = {id} "username": "string", "email": "string", "description": "string", - "admin": "boolean", - "registerDate": "number", - "lastLogin": "number" -} -``` - -## POST /api/v1/user - -_Requires an authorization header_ - -### Request: - -```json -{ - "username": "string", - "password": "string", - "email": "string?", - "description": "string?", - "admin": "boolean?" -} -``` - -Creates a new user and returns it - -### Response: - -```json -{ - "id": "string", - "username": "string", - "email": "string", - "description": "string", - "admin": "boolean" + "admin": false, + "registerDate": 0, + "lastLogin": 0 } ``` @@ -73,20 +43,6 @@ Updates a user with id = {id} } ``` -## DELETE /api/v1/user/{id} - -_Requires an authorization header_ - -Removes a user with id = {id} - -### Response: - -```json -{ - "id": "string" -} -``` - ## GET /api/v1/user/{id}/sessions _Requires an authorization header_