Story: API Story Template

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

SSE/WebsiteTheSSEquel#103

sjv01180 commented

2024-01-28 19:46:44 +00:00

(Migrated from github.com)

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)

# <Quote Model CRUD Commands> As a User, I want to create, read, update, and delete commands on the <api name> data, so that I can build features around the <target data> 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)

Rows
Columns

Story: API Story Template #103

Definition of Done

Acceptance Criteria

Solution Tasks