Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine

[Home Page] - Get Unread Announcements Endpoint

Open
#3,074 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

back-end straightforward
Dominant language
TypeScript
Stars
36
Forks
9
Avg merge
4d 21h
Merged PRs (30d)
11

Description

Description

We need to create an endpoint that will get a user’s unread announcements. This endpoint should be under the route ‘users/:userid/announcements/” that does not take in a payload and returns the unread notifications of a user

Acceptance Criteria
  • a new endpoint is created in the organizations router under the route ‘users/:userid/announcements/ that returns a user’s unread announcements
  • unit tests and postman screenshot
Proposed Solution

Take a look at some of the other get endpoints we have on Finishline and use it as a reference for this endpoint.

Mocks

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the organizations router and inspect existing GET endpoints in FinishLine for routing and response conventions. Add the users/:userid/announcements/ endpoint without a payload, then add unit tests and a Postman screenshot demonstrating that it returns the user's unread announcements.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.