ironhack-edu/data_2.05_activities

API Documentation

We will start our project by first documenting all of the routes and data models for our API. Following best practices we will use verbs to specify the type of operation being done and nouns when naming endpoints.

Routes

Project routes

HTTP verb	URL	Request body	Action
GET	/api/projects	(empty)	Returns all the projects
POST	/api/projects	JSON	Adds a new project
GET	/api/projects/:projectId	(empty)	Returns the specified project
PUT	/api/projects/:projectId	JSON	Edits the specified project
DELETE	/api/projects/:projectId	(empty)	Deletes the specified project

Task routes

HTTP verb	URL	Request body	Action
POST	/api/tasks	JSON	Adds a new task
GET	/api/tasks/:taskId	(empty)	Returns the specified task
PUT	/api/tasks/:taskId	JSON	Edits the specified task
DELETE	/api/tasks/:taskId	(empty)	Deletes the specified task

Auth routes

HTTP verb	URL	Request Headers	Request Body
POST	/auth/signup	--	{ email, password, name }
POST	/auth/login	--	{ email, password }
GET	/auth/verify	Authorization: Bearer < JWT >	--

---

Models

Project Model

{
  title: String,
  description: String,
  tasks: [ { type: Schema.Types.ObjectId, ref: 'Task' } ]
}

Task Model

{
  title: String,
  description: String,
  project: { type: Schema.Types.ObjectId, ref: 'Project' }
}

User Model

{
  email: { type: String, unique: true, required: true },
  password: { type: String, required: true },
  name: { type: String, required: true },
}

data_2.05_activities's Issues

students struggled to understand task

the tables are already linked but the task says to draw the structure out with links... confused.

also the tables are named differently in the diagram from the actual database which makes it confusing.

on first read i thought this one would be fine, but though they do understand the concept, they really didnt like the activity.

can we give them just the tables, and ask them to draw the links, the cardinality, and label the keys - maybe give them an editable file ?
or can this be done in class, interactively in some way

maybe theres an online version of the same activity?

@sandrabosk