Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
arafaysaleem opened this issue Jul 26, 2021 · 0 comments
Labels
user story A brief explanation of a functionality or an interaction with the system, from a user's perspective

Comments

@arafaysaleem
Copy link
Contributor

Summary

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.

Acceptance Criteria

Scenario 1: Search for all possible milestones in a project

GIVEN an contractor is requesting all possible milestones in the desktop app
WHEN the app hits the /projects/:id/milestones endpoint with a valid GET request, containing the path parameter:

  • :id, the unique id of the project for which the milestones are needed.

THEN the app should receive a status 200
AND in the response, the following information should be returned:

  • headers
  • list of milestones

Sample Request/Sample Response
For e.g. If we request milestones for project id 1:

headers: {
    error: 0,
    message: "..."
}
body: [
    {
        milestone_id: 0,
        milestone: "Milestone 1",
        description: "some description",
        objective: "some goal",
        budget: 99999,
        start_datetime: "27-07-2021 02:04:00",
        end_datetime: "27-07-2021 02:04:00",
        project_id: 1,
        progress: 0,
        current_stage_id: 1,
        is_complete: 1,
    },
    {
        milestone_id: 0,
        milestone: "Milestone 1",
        description: "some description",
        objective: "some goal",
        budget: 99999,
        start_datetime: "27-07-2021 02:04:00",
        end_datetime: "27-07-2021 02:04:00",
        project_id: 1,
        progress: 0,
        current_stage_id: 1,
        is_complete: 1,
    },
    ....
]

Scenario 2: Search for all milestones in a project by completion status

GIVEN an contractor is requesting all milestones for a project in the desktop app
WHEN the app hits the /projects/:id/milestones endpoint with a valid GET request, containing:-"

  • the path parameter:
    • :id, the unique id of the project for which the milestones are needed.
  • the query parameters:
    • is_complete="bool", where bool indicates completion**

THEN the app should receive a status 200
AND in the response, the following information should be returned:

  • headers
  • list of milestones having that completion status
    Sample Request/Sample Response
    For project id 1 and query parameter is_complete=1:
headers: {
    error: 0,
    message: "..."
}
body: [
      {
        milestone_id: 0,
        milestone: "Milestone 1",
        description: "some description",
        objective: "some goal",
        budget: 99999,
        start_datetime: "27-07-2021 02:04:00",
        end_datetime: "27-07-2021 02:04:00",
        project_id: 1,
        progress: 0,
        current_stage_id: 1,
        is_complete: 1,
    },
    {
        milestone_id: 10,
        milestone: "Milestone 10",
        description: "some description",
        objective: "some goal",
        budget: 99999,
        start_datetime: "27-07-2021 02:04:00",
        end_datetime: "27-07-2021 02:04:00",
        project_id: 1,
        progress: 0,
        current_stage_id: 1,
        is_complete: 1,
    },
    ....
]

Resources

  • Development URL: {Here goes a URL to the feature on development API}
  • Production URL: {Here goes a URL to the feature on production API}

Dev Notes

Testing Notes

{notes for QA, with examples if applicable}

@arafaysaleem arafaysaleem added the user story A brief explanation of a functionality or an interaction with the system, from a user's perspective label Jul 26, 2021
@arafaysaleem arafaysaleem mentioned this issue Jul 26, 2021
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user story A brief explanation of a functionality or an interaction with the system, from a user's perspective
Projects
None yet
Development

No branches or pull requests

1 participant