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

Story: Officer CRUD API Routes #77

Open
25 tasks
Arc8809 opened this issue Oct 27, 2023 · 1 comment
Open
25 tasks

Story: Officer CRUD API Routes #77

Arc8809 opened this issue Oct 27, 2023 · 1 comment
Assignees

Comments

@Arc8809
Copy link

Arc8809 commented Oct 27, 2023

Officer CRUD API Routes

As a developer, I want to use Create, Read, Update, and Delete commands on the Officer data, so that I can build features around the Officer 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 new data entry.
  • Given I call the create command, when I use invalid fields, then I am returned an HTTP 422 Un-Processable Entity code.
  • Given I call the read command, when I have valid fields, then I am returned the data and an HTTP 200 OK response.
  • Given I call the read command when I have invalid fields, then I am returned an HTTP 403 Forbidden response.
  • Given I call the update command, when I have valid fields, then the data is updated and an HTTP 200 OK response is returned.
  • Given I call the update command, when I have 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)
@2nPlusOne 2nPlusOne changed the title Story: Officer Model CRUD Commands Story: Officer CRUD API Routes Nov 12, 2023
@PokeJofeJr4th
Copy link
Contributor

@Arc8809 could you either bump priority for this or let me take over? It's one of the only things we need for the MVP features

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants