Story: API Story Template

[sjv01180]

As a User, I want to create, read, update, and delete commands on the data, so that I can build features around the Model.

Associated Epic: API CRUD Commands

Definition of Done

• Acceptance criteria defined
• Solution tasks specified
• Feature branch created
• Unit tests written (on API code only for now)
• Solution passes full suite of unit tests
• Design documents updated if needed
• Pull request created
• Code is reviewed
• Code is merged to develop branch
• Tests pass on CI
• Deployed to staging environment
• Acceptance criteria is met

Acceptance Criteria

• Given I call the create command, when I use valid fields, then I am returned an HTTP 200 OK response and the id of the data entry
• Given I call the create command, when use invalid fields, then I am returned an HTTP 422 Un-Processable Entity Code
• Given I call the read command, when I use valid fields, then I am returned the data and an HTTP 200 OK response
• Given I call the read command, when I use invalid fields, then I am returned an HTTP 403 Forbidden response
• Given I call the update command, when I use valid fields, then the data is updated and an HTTP 200 OK response is returned
• Given I call the update command, when I use invalid fields, then I am returned an HTTP 422 Un-Processable Entity Code
• Given I call the delete command, when I have valid fields, then I am returned an HTTP 200 OK response.
• Given I call the delete command when I have invalid fields, then I am returned an HTTP 403 Forbidden response.

Solution Tasks

• Create method accepts inputs and returns HTTP codes.
• Read method returns data and HTTP codes.
• Update method accepts inputs, updates data, and returns HTTP codes.
• Delete method accepts inputs, removes data, and returns HTTP codes.
• All methods have fail cases (i.e., invalid input or exception occurs)