Projects API

[arafaysaleem]

Description

This epic is a goal of the larger epic of REST API and contains functionality for project management in our project. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

This epic is a core part of the overall project.

Hypothesis

The API must provide management and information for projects. This epic is considered complete when the following features are complete:

• Project Management
• Project Roles Roles API #24
• Project Payments Payments API #12
• Project Milestone Milestones API #8
• Project Equipment Equipments API #11
• Project Material Materials API #10

Acceptance criteria and must have scope

We must have Authentication and Persons API setup prior to this. In the end we need to have a collection of following endpoints:

• GET All Projects As a contractor, I should be able to get all projects under me, so that I can review their progress and status #81
• GET Single Project As a contractor, I should be able to get details of a single project, so that I can understand what is the status of the project #80
• GET A Project's Milestones As a contractor, I should be able to get all milestones for a project, so that I can review the completion progress of milestones and identify blockers #82
• GET A Project's Roles As a contractor, I should be able to get all roles for a project, so that I can assign them to milestone stages #83
• GET A Project's Payments As a contractor, I should be able to get all payments for a project, so that I can review the budget spending #75
• GET A Project's Materials As a contractor, I should be able to get all ordered materials for a project, so that I can understand how much of each was ordered and how much did it cost #84
• POST A New Project As a contractor, I should be able to create projects, so that I can setup construction projects #76
• PATCH A Project As a contractor, I should be able to update the details of a project, so that I can adjust it's budget/duration/progress with time #78 , As an inspector or on-site manager, I should be able to update the progress of a project, so that I can take the project nearer to completion. #79
• DELETE A Project As a contractor, I should be able to delete projects, so that I can remove inconsistent or erroneous projects #77
• Documentation
• Tests

Stakeholders

None

Timeline

2 weeks are needed to setup all the foundation, along with testing and documentation plus an additional week to test the merged sub epics. The structure of materials and payments endpoint might change in order to reduce joins to improve search queries.

[arafaysaleem]

This Epic has 3 stages of work:

1. First 2 weeks for completing the base functionality of this API.
2. Remaining sub epics begin and complete 1 week before deadline.
3. Last 1 week to test combined functionality of the merged sub epics.