Role-Assigner - A platform that randomly assign roles to members of a given team.

Vision

Create a platform where teams can use to rotate their team leaders and quality Assurance personnels given a specific time.

---

API Versioning

The API Versioning will follow this format:

https://**/api/v1/** - for version 1 of the api.
https://**/api/v2/** - for version 2 of the api.

API Spec

The preferred JSON object to be returned by the API should be structured as follows:

Registration

POST /api/v1/signup

Example response body:

{
  "user":{
    "email": "john.doe@email.com",
    "username": "johndoe",
    "token": "jwt.token.here",
  }
}

Endpoints

Registration

POST /api/v1/auth/signup

Example request body:

{
  "user":{
    "username": "Johndoe",
    "email": "john.doe@email.com",
    "password": "johndoe123"
  }
}

No authentication required, creates an account for the user

Required fields: email, username, password

Authentication

POST /api/v1/auth/login

Example request body:

{
  "user":{
    "email": "jake@jake.jake",
    "password": "jakejake"
  }
}

No authentication required, returns a token and logs a user in.

Required fields: email, password

ALL ENDPOINTS

##AUTHENTICATION
POST Request -> **/api/v1/auth/signup
POST Request -> **/api/v1/auth/login

##TEAM
POST Request -> **/api/v1/team/members = add a list of team members
GET Request ->  **/api/v1/team/members = get the list of all team members

##ROLE ASSIGNER
POST Request ->  **/api/v1/team/lead = generates a list  of team lead to lead for per specified duration for a certain period of time
POST Request ->  **/api/v1/team/qa = generates a list of 2 qa's to work per specified duration for a certain period of time.