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 admin, I should be able to update the details of a student status, so that I can fix old or inconsistent entries #56

Closed
arafaysaleem opened this issue Aug 25, 2021 · 0 comments · Fixed by #65
Labels
Status: Completed Type: Feature user story A brief explanation of a functionality or an interaction with the system, from a user's perspective

Comments

@arafaysaleem
Copy link
Collaborator

arafaysaleem commented Aug 25, 2021

Summary

As an admin, I should be able to update the details of a student status, so that I can fix old or inconsistent entries.

Acceptance Criteria

GIVEN an admin is editing a student status in the app
WHEN the app hits the /student-statuses/:id endpoint with a valid PATCH request, containing:-
The path parameter:

  • :id, the unique id of the entity of which the details are edited.

And any of the following body parameters:

  • student status

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

  • header message indicating update operation success
  • rows matched
  • rows changed

Sample Request/Sample Response

headers: {
    error: 0,
    message: "The specified item was updated successfully"
}
body: {
    rows_matched: 1,
    rows_changed: 1,
    info: "..."
}

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

{Some complementary notes if necessary}

Testing Notes

Scenario 1: PATCH request is successful

  1. Update a student status with a PATCH request to /student-statuses/:id endpoint
  2. A subsequent GET request to /student-statuses/:id endpoint should return a status code 200
  3. And the student status details with the updated information i.e. matching the initially sent body.
  4. Resubmit a PATCH request to /student-statuses/:id endpoint to reverse the change and ensure status code 200 is returned.

Scenario 2: PATCH request is unsuccessful

  1. Update a student status with a PATCH request to /student-statuses/:id endpoint containing a non-existent student_status_id.
  2. Ensure a 404 status code is returned.
  3. And the response headers' code parameter should contain "NotFoundException".

Scenario 3: PATCH request is incorrect

  1. Send a PATCH request to /student-statuses/:id endpoint with an incorrect key name in the body
  2. Ensure a 422 status code is returned
  3. And the response headers' code parameter should contain "InvalidPropertiesException".
  4. And the response headers' data parameter should contain the name of the invalid parameter.

Scenario 4: PATCH request is forbidden

  1. Send a PATCH request to /student-statuses/:id endpoint using a student account token.
  2. Ensure the response returns a 403 forbidden status code.
  3. And the response headers' code parameter should contain "ForbiddenException"

Scenario 5: PATCH request is unauthorized

  1. Send a PATCH request to /student-statuses/:id endpoint without an authorization token
  2. Ensure a 401 unauthorized status code is returned.
  3. And the response headers' code parameter should contain "TokenMissingException"
@arafaysaleem arafaysaleem added user story A brief explanation of a functionality or an interaction with the system, from a user's perspective Priority: Low Status: Pending Type: Feature labels Aug 25, 2021
@arafaysaleem arafaysaleem mentioned this issue Aug 25, 2021
8 tasks
@arafaysaleem arafaysaleem linked a pull request Sep 4, 2021 that will close this issue
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Completed Type: Feature user story A brief explanation of a functionality or an interaction with the system, from a user's perspective
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant